X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Futils_threshold.h;h=a42c4121cd2f93599e9acacd9e61fa0c6cbd6334;hb=97fe230249ff8bf6aa71acfa206443c4a7238ab7;hp=9c347b977b552213da8818f35537658a121b5f24;hpb=34749e7ebe508b1d563af287b180e951b7822bcd;p=collectd.git

diff --git a/src/utils_threshold.h b/src/utils_threshold.h
index 9c347b97..a42c4121 100644
--- a/src/utils_threshold.h
+++ b/src/utils_threshold.h
@@ -1,6 +1,6 @@
 /**
  * collectd - src/utils_threshold.h
- * Copyright (C) 2007  Florian octo Forster
+ * Copyright (C) 2007,2008  Florian octo Forster
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
@@ -26,7 +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 */