bindings/erlang: Added README.

[collectd.git] / src / plugin.h

diff --git a/src/plugin.h b/src/plugin.h
index f4ca783..b35fcf1 100644 (file)
--- a/src/plugin.h
+++ b/src/plugin.h
@@ -24,11 +24,21 @@
 
 #include "collectd.h"
 #include "configfile.h"
+#include "meta_data.h"
 
 #define DATA_MAX_NAME_LEN 64
 
-#define DS_TYPE_COUNTER 0
-#define DS_TYPE_GAUGE   1
+#define DS_TYPE_COUNTER  0
+#define DS_TYPE_GAUGE    1
+#define DS_TYPE_DERIVE   2
+#define DS_TYPE_ABSOLUTE 3
+
+#define DS_TYPE_TO_STRING(t) (t == DS_TYPE_COUNTER)     ? "counter"  : \
+                               (t == DS_TYPE_GAUGE)    ? "gauge"    : \
+                               (t == DS_TYPE_DERIVE)   ? "derive"   : \
+                               (t == DS_TYPE_ABSOLUTE) ? "absolute" : \
+                               "unknown"
+
 
 #ifndef LOG_ERR
 # define LOG_ERR 3
@@ -57,11 +67,15 @@
  */
 typedef unsigned long long counter_t;
 typedef double gauge_t;
+typedef int64_t derive_t;
+typedef uint64_t absolute_t;
 
 union value_u
 {
-       counter_t counter;
-       gauge_t   gauge;
+       counter_t  counter;
+       gauge_t    gauge;
+       derive_t   derive;
+       absolute_t absolute;
 };
 typedef union value_u value_t;
 
@@ -76,11 +90,12 @@ struct value_list_s
        char     plugin_instance[DATA_MAX_NAME_LEN];
        char     type[DATA_MAX_NAME_LEN];
        char     type_instance[DATA_MAX_NAME_LEN];
+       meta_data_t *meta;
 };
 typedef struct value_list_s value_list_t;
 
-#define VALUE_LIST_INIT { NULL, 0, 0, interval_g, "localhost", "", "", "", "" }
-#define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "" }
+#define VALUE_LIST_INIT { NULL, 0, 0, interval_g, "localhost", "", "", "", "", NULL }
+#define VALUE_LIST_STATIC { NULL, 0, 0, 0, "localhost", "", "", "", "", NULL }
 
 struct data_source_s
 {
@@ -136,6 +151,28 @@ typedef struct notification_s
        notification_meta_t *meta;
 } notification_t;
 
+struct user_data_s
+{
+       void *data;
+       void (*free_func) (void *);
+};
+typedef struct user_data_s user_data_t;
+
+/*
+ * Callback types
+ */
+typedef int (*plugin_init_cb) (void);
+typedef int (*plugin_read_cb) (user_data_t *);
+typedef int (*plugin_write_cb) (const data_set_t *, const value_list_t *,
+               user_data_t *);
+typedef int (*plugin_flush_cb) (int timeout, const char *identifier,
+               user_data_t *);
+typedef void (*plugin_log_cb) (int severity, const char *message,
+               user_data_t *);
+typedef int (*plugin_shutdown_cb) (void);
+typedef int (*plugin_notification_cb) (const notification_t *,
+               user_data_t *);
+
 /*
  * NAME
  *  plugin_set_dir
@@ -186,7 +223,7 @@ void plugin_shutdown_all (void);
  * DESCRIPTION
  *  Calls the write function of the given plugin with the provided data set and
  *  value list. It differs from `plugin_dispatch_value' in that it does not
- *  update the cache, does no do threshold checking, call the chain subsystem
+ *  update the cache, does not do threshold checking, call the chain subsystem
  *  and so on. It looks up the requested plugin and invokes the function, end
  *  of story.
  *
@@ -195,7 +232,7 @@ void plugin_shutdown_all (void);
  *             write functions.
  *  ds         Pointer to the data_set_t structure. If NULL, the data set is
  *             looked up according to the `type' member in the `vl' argument.
- *  vl         The actual value to be processes. Must not be NULL.
+ *  vl         The actual value to be processed. Must not be NULL.
  *
  * RETURN VALUE
  *  Returns zero upon success or non-zero if an error occurred. If `plugin' is
@@ -222,25 +259,30 @@ int plugin_register_config (const char *name,
 int plugin_register_complex_config (const char *type,
                int (*callback) (oconfig_item_t *));
 int plugin_register_init (const char *name,
-               int (*callback) (void));
+               plugin_init_cb callback);
 int plugin_register_read (const char *name,
                int (*callback) (void));
+int plugin_register_complex_read (const char *name,
+               plugin_read_cb callback,
+               const struct timespec *interval,
+               user_data_t *user_data);
 int plugin_register_write (const char *name,
-               int (*callback) (const data_set_t *ds, const value_list_t *vl));
+               plugin_write_cb callback, user_data_t *user_data);
 int plugin_register_flush (const char *name,
-               int (*callback) (const int timeout, const char *identifier));
+               plugin_flush_cb callback, user_data_t *user_data);
 int plugin_register_shutdown (char *name,
-               int (*callback) (void));
+               plugin_shutdown_cb callback);
 int plugin_register_data_set (const data_set_t *ds);
-int plugin_register_log (char *name,
-               void (*callback) (int, const char *));
+int plugin_register_log (const char *name,
+               plugin_log_cb callback, user_data_t *user_data);
 int plugin_register_notification (const char *name,
-               int (*callback) (const notification_t *notif));
+               plugin_notification_cb callback, user_data_t *user_data);
 
 int plugin_unregister_config (const char *name);
 int plugin_unregister_complex_config (const char *name);
 int plugin_unregister_init (const char *name);
 int plugin_unregister_read (const char *name);
+int plugin_unregister_complex_read (const char *name, void **user_data);
 int plugin_unregister_write (const char *name);
 int plugin_unregister_flush (const char *name);
 int plugin_unregister_shutdown (const char *name);
@@ -301,6 +343,6 @@ int plugin_notification_meta_add_boolean (notification_t *n,
 int plugin_notification_meta_copy (notification_t *dst,
     const notification_t *src);
 
-int plugin_notification_meta_free (notification_t *n);
+int plugin_notification_meta_free (notification_meta_t *n);
 
 #endif /* PLUGIN_H */