2 * Copyright 2017 Florian Forster
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * Florian octo Forster <octo at collectd.org>
26 #ifndef LIBCOLLECTD_SERVER_H
27 #define LIBCOLLECTD_SERVER_H 1
29 #include "collectd/lcc_features.h"
31 #include "collectd/network.h" /* for lcc_security_level_t */
32 #include "collectd/network_parse.h" /* for lcc_network_parse_options_t */
33 #include "collectd/types.h"
39 /* lcc_network_parser_t is a callback that parses received network packets. It
40 * is expected to call lcc_network_parse_options_t.writer with each
41 * lcc_value_list_t it parses that has the required security level. */
42 typedef int (*lcc_network_parser_t)(void *payload, size_t payload_size,
43 lcc_network_parse_options_t opts);
45 /* lcc_listener_t holds parameters for running a collectd server. */
47 /* conn is a UDP socket for the server to listen on. */
50 /* node is the local address to listen on if conn is <0. Defaults to "::" (any
54 /* service is the local address to listen on if conn is <0. Defaults to
55 * LCC_DEFAULT_PORT. */
58 /* parser is the callback used to parse incoming network packets. Defaults to
59 * lcc_network_parse() if set to NULL. */
60 lcc_network_parser_t parser;
62 /* writer is the callback used to send incoming lcc_value_list_t to. */
63 lcc_value_list_writer_t writer;
65 /* buffer_size determines the maximum packet size to accept. */
68 /* password_lookup is used to look up the password for a given username. */
69 lcc_password_lookup_t password_lookup;
71 /* security_level is the minimal required security level. */
72 lcc_security_level_t security_level;
74 /* interface is the name of the interface to use when subscribing to a
75 * multicast group. Has no effect when using unicast. */
79 /* lcc_listen_and_write listens on the provided UDP socket (or opens one using
80 * srv.addr if srv.conn is less than zero), parses the received packets and
81 * writes them to the provided lcc_value_list_writer_t. Returns non-zero on
82 * failure and does not return otherwise. */
83 int lcc_listen_and_write(lcc_listener_t srv);
87 #endif /* LIBCOLLECTD_SERVER_H */