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/types.h"
37 /* lcc_value_list_writer_t is a write callback to which value lists are
39 typedef int (*lcc_value_list_writer_t)(lcc_value_list_t const *);
41 /* lcc_listener_t holds parameters for running a collectd server. */
43 /* conn is a UDP socket for the server to listen on. */
46 /* node is the local address to listen on if conn is <0. Defaults to "::" (any
50 /* service is the local address to listen on if conn is <0. Defaults to
51 * LCC_DEFAULT_PORT. */
54 /* writer is the callback used to send incoming lcc_value_list_t to. */
55 lcc_value_list_writer_t writer;
57 /* buffer_size determines the maximum packet size to accept. */
60 /* TODO(octo): User to password lookup. */
61 /* char const * (*password_lookup) (char const *); */
63 /* TODO(octo): Minimal required security level. */
64 /* int security_level; */
66 /* interface is the name of the interface to use when subscribing to a
67 * multicast group. Has no effect when using unicast. */
71 /* lcc_listen_and_write listens on the provided UDP socket (or opens one using
72 * srv.addr if srv.conn is less than zero), parses the received packets and
73 * writes them to the provided lcc_value_list_writer_t. Returns non-zero on
74 * failure and does not return otherwise. */
75 int lcc_listen_and_write(lcc_listener_t srv);
77 /* lcc_network_parse parses data received from the network and calls "w" with
78 * the parsed lcc_value_list_ts. */
79 /* TODO(octo): the Go code returns a []api.ValueList. Should we return a
80 * value_list_t** here? */
81 int lcc_network_parse(void *buffer, size_t buffer_size,
82 lcc_value_list_writer_t w);
86 /* vim: set sw=2 sts=2 et : */
87 #endif /* LIBCOLLECTD_SERVER_H */