/**
- * collectd - src/utils_cache.h
+ * collectd - utils_cache.h
* Copyright (C) 2007 Florian octo Forster
+ * Copyright (C) 2016 Sebastian tokkee Harl
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
*
* Authors:
* Florian octo Forster <octo at collectd.org>
+ * Sebastian tokkee Harl <sh at tokkee.org>
**/
#ifndef UTILS_CACHE_H
#include "plugin.h"
-#define STATE_OKAY 0
-#define STATE_WARNING 1
-#define STATE_ERROR 2
+#define STATE_OKAY 0
+#define STATE_WARNING 1
+#define STATE_ERROR 2
#define STATE_MISSING 15
-int uc_init (void);
-int uc_check_timeout (void);
-int uc_update (const data_set_t *ds, const value_list_t *vl);
-int uc_get_rate_by_name (const char *name, gauge_t **ret_values, size_t *ret_values_num);
-gauge_t *uc_get_rate (const data_set_t *ds, const value_list_t *vl);
+int uc_init(void);
+int uc_check_timeout(void);
+int uc_update(const data_set_t *ds, const value_list_t *vl);
+int uc_get_rate_by_name(const char *name, gauge_t **ret_values,
+ size_t *ret_values_num);
+gauge_t *uc_get_rate(const data_set_t *ds, const value_list_t *vl);
-size_t uc_get_size (void);
-int uc_get_names (char ***ret_names, cdtime_t **ret_times, size_t *ret_number);
+size_t uc_get_size(void);
+int uc_get_names(char ***ret_names, cdtime_t **ret_times, size_t *ret_number);
-int uc_get_state (const data_set_t *ds, const value_list_t *vl);
-int uc_set_state (const data_set_t *ds, const value_list_t *vl, int state);
-int uc_get_hits (const data_set_t *ds, const value_list_t *vl);
-int uc_set_hits (const data_set_t *ds, const value_list_t *vl, int hits);
-int uc_inc_hits (const data_set_t *ds, const value_list_t *vl, int step);
+int uc_get_state(const data_set_t *ds, const value_list_t *vl);
+int uc_set_state(const data_set_t *ds, const value_list_t *vl, int state);
+int uc_get_hits(const data_set_t *ds, const value_list_t *vl);
+int uc_set_hits(const data_set_t *ds, const value_list_t *vl, int hits);
+int uc_inc_hits(const data_set_t *ds, const value_list_t *vl, int step);
-int uc_get_history (const data_set_t *ds, const value_list_t *vl,
- gauge_t *ret_history, size_t num_steps, size_t num_ds);
-int uc_get_history_by_name (const char *name,
- gauge_t *ret_history, size_t num_steps, size_t num_ds);
+int uc_get_history(const data_set_t *ds, const value_list_t *vl,
+ gauge_t *ret_history, size_t num_steps, size_t num_ds);
+int uc_get_history_by_name(const char *name, gauge_t *ret_history,
+ size_t num_steps, size_t num_ds);
+
+/*
+ * Iterator interface
+ */
+struct uc_iter_s;
+typedef struct uc_iter_s uc_iter_t;
+
+/*
+ * NAME
+ * uc_get_iterator
+ *
+ * DESCRIPTION
+ * Create an iterator for the cache. It will hold the cache lock until it's
+ * destroyed.
+ *
+ * RETURN VALUE
+ * An iterator object on success or NULL else.
+ */
+uc_iter_t *uc_get_iterator(void);
+
+/*
+ * NAME
+ * uc_iterator_next
+ *
+ * DESCRIPTION
+ * Advance the iterator to the next positiion and (optionally) returns the
+ * name of the entry.
+ *
+ * PARAMETERS
+ * `iter' The iterator object to advance.
+ * `ret_name' Optional pointer to a string where to store the name. If not
+ * NULL, the returned value is a copy of the value and has to be
+ * freed by the caller.
+ *
+ * RETURN VALUE
+ * Zero upon success or non-zero if the iterator ie NULL or no further
+ * values are available.
+ */
+int uc_iterator_next(uc_iter_t *iter, char **ret_name);
+void uc_iterator_destroy(uc_iter_t *iter);
+
+/* Return the timestamp of the value at the current position. */
+int uc_iterator_get_time(uc_iter_t *iter, cdtime_t *ret_time);
+/* Return the (raw) value at the current position. */
+int uc_iterator_get_values(uc_iter_t *iter, value_t **ret_values,
+ size_t *ret_num);
+/* Return the interval of the value at the current position. */
+int uc_iterator_get_interval(uc_iter_t *iter, cdtime_t *ret_interval);
/*
* Meta data interface
*/
-int uc_meta_data_exists (const value_list_t *vl, const char *key);
-int uc_meta_data_delete (const value_list_t *vl, const char *key);
+int uc_meta_data_exists(const value_list_t *vl, const char *key);
+int uc_meta_data_delete(const value_list_t *vl, const char *key);
-int uc_meta_data_add_string (const value_list_t *vl,
- const char *key,
- const char *value);
-int uc_meta_data_add_signed_int (const value_list_t *vl,
- const char *key,
- int64_t value);
-int uc_meta_data_add_unsigned_int (const value_list_t *vl,
- const char *key,
- uint64_t value);
-int uc_meta_data_add_double (const value_list_t *vl,
- const char *key,
- double value);
-int uc_meta_data_add_boolean (const value_list_t *vl,
- const char *key,
- _Bool value);
+int uc_meta_data_add_string(const value_list_t *vl, const char *key,
+ const char *value);
+int uc_meta_data_add_signed_int(const value_list_t *vl, const char *key,
+ int64_t value);
+int uc_meta_data_add_unsigned_int(const value_list_t *vl, const char *key,
+ uint64_t value);
+int uc_meta_data_add_double(const value_list_t *vl, const char *key,
+ double value);
+int uc_meta_data_add_boolean(const value_list_t *vl, const char *key,
+ _Bool value);
-int uc_meta_data_get_string (const value_list_t *vl,
- const char *key,
- char **value);
-int uc_meta_data_get_signed_int (const value_list_t *vl,
- const char *key,
- int64_t *value);
-int uc_meta_data_get_unsigned_int (const value_list_t *vl,
- const char *key,
- uint64_t *value);
-int uc_meta_data_get_double (const value_list_t *vl,
- const char *key,
- double *value);
-int uc_meta_data_get_boolean (const value_list_t *vl,
- const char *key,
- _Bool *value);
+int uc_meta_data_get_string(const value_list_t *vl, const char *key,
+ char **value);
+int uc_meta_data_get_signed_int(const value_list_t *vl, const char *key,
+ int64_t *value);
+int uc_meta_data_get_unsigned_int(const value_list_t *vl, const char *key,
+ uint64_t *value);
+int uc_meta_data_get_double(const value_list_t *vl, const char *key,
+ double *value);
+int uc_meta_data_get_boolean(const value_list_t *vl, const char *key,
+ _Bool *value);
/* vim: set shiftwidth=2 softtabstop=2 tabstop=8 : */
#endif /* !UTILS_CACHE_H */
projects / collectd.git / blobdiff