ns_monitor.h

00001 /*
00002  * Copyright (c) 2019, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License");
00006  * you may not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  *     http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS,
00013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 
00018 /**
00019  * \file ns_monitor.h
00020  * \brief Utility functions concerning IPv6 stack monitoring.
00021  *
00022  * Module can monitor nanostack heap usage and release memory if heap usage is too high.
00023  * Mmeory monitoring can work if memory statistics are enabled in nsdynmemLIB.
00024  *
00025  */
00026 
00027 #ifndef _NS_MONITOR_H
00028 #define _NS_MONITOR_H
00029 
00030 int ns_monitor_init(void);
00031 
00032 int ns_monitor_clear(void);
00033 
00034 void ns_monitor_timer(uint16_t seconds);
00035 
00036 int ns_monitor_heap_gc_threshold_set(uint8_t percentage_high, uint8_t percentage_critical);
00037 
00038 #endif // _NS_MONITOR_H
00039