src/libcollectdclient/collectd/server.h

   1 /**
   2  * Copyright 2017 Florian Forster
   3  *
   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:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  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
  20  * SOFTWARE.
  21  *
  22  * Authors:
  23  *   Florian octo Forster <octo at collectd.org>
  24  **/
  25
  26 #ifndef LIBCOLLECTD_SERVER_H
  27 #define LIBCOLLECTD_SERVER_H 1
  28
  29 #include "collectd/lcc_features.h"
  30
  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"
  34
  35 #include <stdint.h>
  36
  37 #ifndef LCC_NETWORK_BUFFER_SIZE
  38 #define LCC_NETWORK_BUFFER_SIZE 1452
  39 #endif
  40
  41 LCC_BEGIN_DECLS
  42
  43 /* lcc_network_parser_t is a callback that parses received network packets. It
  44  * is expected to call lcc_network_parse_options_t.writer with each
  45  * lcc_value_list_t it parses that has the required security level. */
  46 typedef int (*lcc_network_parser_t)(void *payload, size_t payload_size,
  47                                     lcc_network_parse_options_t opts);
  48
  49 /* lcc_listener_t holds parameters for running a collectd server. */
  50 typedef struct {
  51   /* conn is a UDP socket for the server to listen on. If set to <0 node and
  52    * service will be used to open a new UDP socket. If >=0, it is the caller's
  53    * job to clean up the socket. */
  54   int conn;
  55
  56   /* node is the local address to listen on if conn is <0. Defaults to "::" (any
  57    * address). */
  58   char *node;
  59
  60   /* service is the local address to listen on if conn is <0. Defaults to
  61    * LCC_DEFAULT_PORT. */
  62   char *service;
  63
  64   /* parser is the callback used to parse incoming network packets. Defaults to
  65    * lcc_network_parse() if set to NULL. */
  66   lcc_network_parser_t parser;
  67
  68   /* parse_options contains options for parser and is passed on verbatimely. */
  69   lcc_network_parse_options_t parse_options;
  70
  71   /* buffer_size determines the maximum packet size to accept. Defaults to
  72    * LCC_NETWORK_BUFFER_SIZE if set to zero. */
  73   uint16_t buffer_size;
  74
  75   /* interface is the name of the interface to use when subscribing to a
  76    * multicast group. Has no effect when using unicast. */
  77   char *interface;
  78 } lcc_listener_t;
  79
  80 /* lcc_listen_and_write listens on the provided UDP socket (or opens one using
  81  * srv.addr if srv.conn is less than zero), parses the received packets and
  82  * writes them to the provided lcc_value_list_writer_t. Returns non-zero on
  83  * failure and does not return otherwise. */
  84 int lcc_listen_and_write(lcc_listener_t srv);
  85
  86 LCC_END_DECLS
  87
  88 #endif /* LIBCOLLECTD_SERVER_H */