1 /**
2 * collection4 - graph.h
3 * Copyright (C) 2010 Florian octo Forster
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 * Boston, MA 02110-1301 USA
19 *
20 * Authors:
21 * Florian octo Forster <ff at octo.it>
22 **/
24 #ifndef GRAPH_H
25 #define GRAPH_H 1
27 #include "graph_types.h"
28 #include "graph_ident.h"
29 #include "oconfig.h"
30 #include "rrd_args.h"
31 #include "utils_array.h"
33 /*
34 * Functions
35 */
36 graph_config_t *graph_create (const graph_ident_t *selector);
38 void graph_destroy (graph_config_t *graph);
40 int graph_config_add (const oconfig_item_t *ci);
42 int graph_add_file (graph_config_t *cfg, const graph_ident_t *file);
44 int graph_get_title (graph_config_t *cfg,
45 char *buffer, size_t buffer_size);
47 int graph_get_params (graph_config_t *cfg, char *buffer, size_t buffer_size);
49 graph_ident_t *graph_get_selector (graph_config_t *cfg);
51 graph_def_t *graph_get_defs (graph_config_t *cfg);
53 int graph_add_def (graph_config_t *cfg, graph_def_t *def);
55 _Bool graph_matches_ident (graph_config_t *cfg, const graph_ident_t *ident);
57 /* Compares the given string with the appropriate field of the selector. If the
58 * selector field is "/all/" or "/any/", returns true without checking the
59 * instances. See "graph_inst_search_field" for finding all matching instances.
60 * */
61 _Bool graph_matches_field (graph_config_t *cfg,
62 graph_ident_field_t field, const char *field_value);
64 int graph_inst_foreach (graph_config_t *cfg,
65 inst_callback_t cb, void *user_data);
67 graph_instance_t *graph_inst_find_exact (graph_config_t *cfg,
68 graph_ident_t *ident);
70 graph_instance_t *graph_inst_find_matching (graph_config_t *cfg,
71 const graph_ident_t *ident);
73 int graph_inst_find_all_matching (graph_config_t *cfg,
74 const graph_ident_t *ident,
75 graph_inst_callback_t callback, void *user_data);
77 int graph_inst_search (graph_config_t *cfg, const char *term,
78 graph_inst_callback_t callback, void *user_data);
80 /* Iterates over all instances and calls "inst_matches_field". If that method
81 * returns true, calls the callback with the graph and instance pointers. */
82 int graph_inst_search_field (graph_config_t *cfg,
83 graph_ident_field_t field, const char *field_value,
84 graph_inst_callback_t callback, void *user_data);
86 int graph_compare (graph_config_t *cfg, const graph_ident_t *ident);
88 int graph_sort_instances (graph_config_t *cfg);
90 int graph_clear_instances (graph_config_t *cfg);
92 int graph_get_rrdargs (graph_config_t *cfg, graph_instance_t *inst,
93 rrd_args_t *args);
95 #endif /* GRAPH_H */
96 /* vim: set sw=2 sts=2 et fdm=marker : */