1 /**
2 * collectd - utils_cache.h
3 * Copyright (C) 2007 Florian octo Forster
4 * Copyright (C) 2016 Sebastian tokkee Harl
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *
24 * Authors:
25 * Florian octo Forster <octo at collectd.org>
26 * Sebastian tokkee Harl <sh at tokkee.org>
27 **/
29 #ifndef UTILS_CACHE_H
30 #define UTILS_CACHE_H 1
32 #include "plugin.h"
34 #define STATE_OKAY 0
35 #define STATE_WARNING 1
36 #define STATE_ERROR 2
37 #define STATE_MISSING 15
39 int uc_init(void);
40 int uc_check_timeout(void);
41 int uc_update(const data_set_t *ds, const value_list_t *vl);
42 int uc_get_rate_by_name(const char *name, gauge_t **ret_values,
43 size_t *ret_values_num);
44 gauge_t *uc_get_rate(const data_set_t *ds, const value_list_t *vl);
45 int uc_get_value_by_name(const char *name, value_t **ret_values, size_t *ret_values_num);
46 value_t *uc_get_value(const data_set_t *ds, const value_list_t *vl);
48 size_t uc_get_size(void);
49 int uc_get_names(char ***ret_names, cdtime_t **ret_times, size_t *ret_number);
51 int uc_get_state(const data_set_t *ds, const value_list_t *vl);
52 int uc_set_state(const data_set_t *ds, const value_list_t *vl, int state);
53 int uc_get_hits(const data_set_t *ds, const value_list_t *vl);
54 int uc_set_hits(const data_set_t *ds, const value_list_t *vl, int hits);
55 int uc_inc_hits(const data_set_t *ds, const value_list_t *vl, int step);
57 int uc_get_history(const data_set_t *ds, const value_list_t *vl,
58 gauge_t *ret_history, size_t num_steps, size_t num_ds);
59 int uc_get_history_by_name(const char *name, gauge_t *ret_history,
60 size_t num_steps, size_t num_ds);
62 /*
63 * Iterator interface
64 */
65 struct uc_iter_s;
66 typedef struct uc_iter_s uc_iter_t;
68 /*
69 * NAME
70 * uc_get_iterator
71 *
72 * DESCRIPTION
73 * Create an iterator for the cache. It will hold the cache lock until it's
74 * destroyed.
75 *
76 * RETURN VALUE
77 * An iterator object on success or NULL else.
78 */
79 uc_iter_t *uc_get_iterator(void);
81 /*
82 * NAME
83 * uc_iterator_next
84 *
85 * DESCRIPTION
86 * Advance the iterator to the next positiion and (optionally) returns the
87 * name of the entry.
88 *
89 * PARAMETERS
90 * `iter' The iterator object to advance.
91 * `ret_name' Optional pointer to a string where to store the name. If not
92 * NULL, the returned value is a copy of the value and has to be
93 * freed by the caller.
94 *
95 * RETURN VALUE
96 * Zero upon success or non-zero if the iterator ie NULL or no further
97 * values are available.
98 */
99 int uc_iterator_next(uc_iter_t *iter, char **ret_name);
100 void uc_iterator_destroy(uc_iter_t *iter);
102 /* Return the timestamp of the value at the current position. */
103 int uc_iterator_get_time(uc_iter_t *iter, cdtime_t *ret_time);
104 /* Return the (raw) value at the current position. */
105 int uc_iterator_get_values(uc_iter_t *iter, value_t **ret_values,
106 size_t *ret_num);
107 /* Return the interval of the value at the current position. */
108 int uc_iterator_get_interval(uc_iter_t *iter, cdtime_t *ret_interval);
109 /* Return the metadata for the value at the current position. */
110 int uc_iterator_get_meta(uc_iter_t *iter, meta_data_t **ret_meta);
112 /*
113 * Meta data interface
114 */
115 int uc_meta_data_exists(const value_list_t *vl, const char *key);
116 int uc_meta_data_delete(const value_list_t *vl, const char *key);
118 int uc_meta_data_add_string(const value_list_t *vl, const char *key,
119 const char *value);
120 int uc_meta_data_add_signed_int(const value_list_t *vl, const char *key,
121 int64_t value);
122 int uc_meta_data_add_unsigned_int(const value_list_t *vl, const char *key,
123 uint64_t value);
124 int uc_meta_data_add_double(const value_list_t *vl, const char *key,
125 double value);
126 int uc_meta_data_add_boolean(const value_list_t *vl, const char *key,
127 _Bool value);
129 int uc_meta_data_get_string(const value_list_t *vl, const char *key,
130 char **value);
131 int uc_meta_data_get_signed_int(const value_list_t *vl, const char *key,
132 int64_t *value);
133 int uc_meta_data_get_unsigned_int(const value_list_t *vl, const char *key,
134 uint64_t *value);
135 int uc_meta_data_get_double(const value_list_t *vl, const char *key,
136 double *value);
137 int uc_meta_data_get_boolean(const value_list_t *vl, const char *key,
138 _Bool *value);
140 #endif /* !UTILS_CACHE_H */