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);
46 size_t uc_get_size(void);
47 int uc_get_names(char ***ret_names, cdtime_t **ret_times, size_t *ret_number);
49 int uc_get_state(const data_set_t *ds, const value_list_t *vl);
50 int uc_set_state(const data_set_t *ds, const value_list_t *vl, int state);
51 int uc_get_hits(const data_set_t *ds, const value_list_t *vl);
52 int uc_set_hits(const data_set_t *ds, const value_list_t *vl, int hits);
53 int uc_inc_hits(const data_set_t *ds, const value_list_t *vl, int step);
55 int uc_get_history(const data_set_t *ds, const value_list_t *vl,
56 gauge_t *ret_history, size_t num_steps, size_t num_ds);
57 int uc_get_history_by_name(const char *name, gauge_t *ret_history,
58 size_t num_steps, size_t num_ds);
60 /*
61 * Iterator interface
62 */
63 struct uc_iter_s;
64 typedef struct uc_iter_s uc_iter_t;
66 /*
67 * NAME
68 * uc_get_iterator
69 *
70 * DESCRIPTION
71 * Create an iterator for the cache. It will hold the cache lock until it's
72 * destroyed.
73 *
74 * RETURN VALUE
75 * An iterator object on success or NULL else.
76 */
77 uc_iter_t *uc_get_iterator(void);
79 /*
80 * NAME
81 * uc_iterator_next
82 *
83 * DESCRIPTION
84 * Advance the iterator to the next positiion and (optionally) returns the
85 * name of the entry.
86 *
87 * PARAMETERS
88 * `iter' The iterator object to advance.
89 * `ret_name' Optional pointer to a string where to store the name. If not
90 * NULL, the returned value is a copy of the value and has to be
91 * freed by the caller.
92 *
93 * RETURN VALUE
94 * Zero upon success or non-zero if the iterator ie NULL or no further
95 * values are available.
96 */
97 int uc_iterator_next(uc_iter_t *iter, char **ret_name);
98 void uc_iterator_destroy(uc_iter_t *iter);
100 /* Return the timestamp of the value at the current position. */
101 int uc_iterator_get_time(uc_iter_t *iter, cdtime_t *ret_time);
102 /* Return the (raw) value at the current position. */
103 int uc_iterator_get_values(uc_iter_t *iter, value_t **ret_values,
104 size_t *ret_num);
105 /* Return the interval of the value at the current position. */
106 int uc_iterator_get_interval(uc_iter_t *iter, cdtime_t *ret_interval);
108 /*
109 * Meta data interface
110 */
111 int uc_meta_data_exists(const value_list_t *vl, const char *key);
112 int uc_meta_data_delete(const value_list_t *vl, const char *key);
114 int uc_meta_data_add_string(const value_list_t *vl, const char *key,
115 const char *value);
116 int uc_meta_data_add_signed_int(const value_list_t *vl, const char *key,
117 int64_t value);
118 int uc_meta_data_add_unsigned_int(const value_list_t *vl, const char *key,
119 uint64_t value);
120 int uc_meta_data_add_double(const value_list_t *vl, const char *key,
121 double value);
122 int uc_meta_data_add_boolean(const value_list_t *vl, const char *key,
123 _Bool value);
125 int uc_meta_data_get_string(const value_list_t *vl, const char *key,
126 char **value);
127 int uc_meta_data_get_signed_int(const value_list_t *vl, const char *key,
128 int64_t *value);
129 int uc_meta_data_get_unsigned_int(const value_list_t *vl, const char *key,
130 uint64_t *value);
131 int uc_meta_data_get_double(const value_list_t *vl, const char *key,
132 double *value);
133 int uc_meta_data_get_boolean(const value_list_t *vl, const char *key,
134 _Bool *value);
136 /* vim: set shiftwidth=2 softtabstop=2 tabstop=8 : */
137 #endif /* !UTILS_CACHE_H */