From d46f48f40cdf847de5cb5fcdf5463d1f3e3f6367 Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Wed, 19 Dec 2007 15:07:33 +0100 Subject: [PATCH] src/utils_threshold.h: Documented the public functions. --- src/utils_threshold.h | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/src/utils_threshold.h b/src/utils_threshold.h index 139d6f9f..dfc42d19 100644 --- a/src/utils_threshold.h +++ b/src/utils_threshold.h @@ -26,8 +26,32 @@ #include "liboconfig/oconfig.h" #include "plugin.h" +/* + * ut_config + * + * Parses the configuration and sets up the module. This is called from + * `src/configfile.c'. + */ int ut_config (const oconfig_item_t *ci); + +/* + * ut_check_threshold + * + * Checks if a threshold is defined for this value and if such a threshold is + * configured, check if the value within the acceptable range. If it is not, a + * notification is dispatched to inform the user that a problem exists. This is + * called from `plugin_read_all'. + */ int ut_check_threshold (const data_set_t *ds, const value_list_t *vl); + +/* + * Given an identification returns + * 0: No threshold is defined. + * 1: A threshold has been found. The flag `persist' is off. + * 2: A threshold has been found. The flag `persist' is on. + * (That is, it is expected that many notifications are sent until the + * problem disappears.) + */ int ut_check_interesting (const char *name); #endif /* UTILS_THRESHOLD_H */ -- 2.11.0