1 /**
2 * collectd - src/utils_match.h
3 * Copyright (C) 2008 Florian octo Forster
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; either version 2 of the License, or (at your
8 * option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 *
19 * Authors:
20 * Florian octo Forster <octo at verplant.org>
21 **/
23 #ifndef UTILS_MATCH_H
24 #define UTILS_MATCH_H 1
26 #include "plugin.h"
28 /*
29 * Defines
30 */
31 #define UTILS_MATCH_DS_TYPE_GAUGE 0x10
32 #define UTILS_MATCH_DS_TYPE_COUNTER 0x20
34 #define UTILS_MATCH_CF_GAUGE_AVERAGE 0x01
35 #define UTILS_MATCH_CF_GAUGE_MIN 0x02
36 #define UTILS_MATCH_CF_GAUGE_MAX 0x04
37 #define UTILS_MATCH_CF_GAUGE_LAST 0x08
39 #define UTILS_MATCH_CF_COUNTER_SET 0x01
40 #define UTILS_MATCH_CF_COUNTER_ADD 0x02
41 #define UTILS_MATCH_CF_COUNTER_INC 0x04
43 /*
44 * Data types
45 */
46 struct cu_match_s;
47 typedef struct cu_match_s cu_match_t;
49 struct cu_match_value_s
50 {
51 int ds_type;
52 value_t value;
53 unsigned int values_num;
54 };
55 typedef struct cu_match_value_s cu_match_value_t;
57 /*
58 * Prototypes
59 */
60 /*
61 * NAME
62 * match_create_callback
63 *
64 * DESCRIPTION
65 * Creates a new `cu_match_t' object which will use the regular expression
66 * `regex' to match lines, see the `match_apply' method below. If the line
67 * matches, the callback passed in `callback' will be called along with the
68 * pointer `user_pointer'.
69 * The string that's passed to the callback depends on the regular expression:
70 * If the regular expression includes a sub-match, i. e. something like
71 * "value=([0-9][0-9]*)"
72 * then only the submatch (the part in the parenthesis) will be passed to the
73 * callback. If there is no submatch, then the entire string is passed to the
74 * callback.
75 */
76 cu_match_t *match_create_callback (const char *regex,
77 int (*callback) (const char *str,
78 char * const *matches, size_t matches_num, void *user_data),
79 void *user_data);
81 /*
82 * NAME
83 * match_create_simple
84 *
85 * DESCRIPTION
86 * Creates a new `cu_match_t' with a default callback. The user data for that
87 * default callback will be a `cu_match_value_t' structure, with
88 * `ds_type' copied to the structure. The default callback will handle the
89 * string as containing a number (see strtoll(3) and strtod(3)) and store that
90 * number in the `value' member. How that is done depends on `ds_type':
91 *
92 * UTILS_MATCH_DS_TYPE_GAUGE
93 * The function will search for a floating point number in the string and
94 * store it in value.gauge.
95 * UTILS_MATCH_DS_TYPE_COUNTER_SET
96 * The function will search for an integer in the string and store it in
97 * value.counter.
98 * UTILS_MATCH_DS_TYPE_COUNTER_ADD
99 * The function will search for an integer in the string and add it to the
100 * value in value.counter.
101 * UTILS_MATCH_DS_TYPE_COUNTER_INC
102 * The function will not search for anything in the string and increase
103 * value.counter by one.
104 */
105 cu_match_t *match_create_simple (const char *regex, int ds_type);
107 /*
108 * NAME
109 * match_destroy
110 *
111 * DESCRIPTION
112 * Destroys the object and frees all internal resources.
113 */
114 void match_destroy (cu_match_t *obj);
116 /*
117 * NAME
118 * match_apply
119 *
120 * DESCRIPTION
121 * Tries to match the string `str' with the regular expression of `obj'. If
122 * the string matches, calls the callback in `obj' with the (sub-)match.
123 *
124 * The user_data pointer passed to `match_create_callback' is NOT freed
125 * automatically. The `cu_match_value_t' structure allocated by
126 * `match_create_callback' is freed automatically.
127 */
128 int match_apply (cu_match_t *obj, const char *str);
130 /*
131 * NAME
132 * match_get_user_data
133 *
134 * DESCRIPTION
135 * Returns the pointer passed to `match_create_callback' or a pointer to the
136 * `cu_match_value_t' structure allocated by `match_create_simple'.
137 */
138 void *match_get_user_data (cu_match_t *obj);
140 #endif /* UTILS_MATCH_H */
142 /* vim: set sw=2 sts=2 ts=8 : */