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/types.h"
  32 #include "collectd/network.h" /* for lcc_security_level_t */
  33
  34 #include <stdint.h>
  35
  36 LCC_BEGIN_DECLS
  37
  38 /* lcc_value_list_writer_t is a write callback to which value lists are
  39  * dispatched. */
  40 typedef int (*lcc_value_list_writer_t)(lcc_value_list_t const *);
  41
  42 /* lcc_password_lookup_t is a callback for looking up the password for a given
  43  * user. Must return NULL if the user is not known. */
  44 typedef char const *(*lcc_password_lookup_t)(char const *);
  45
  46 /* lcc_listener_t holds parameters for running a collectd server. */
  47 typedef struct {
  48   /* conn is a UDP socket for the server to listen on. */
  49   int conn;
  50
  51   /* node is the local address to listen on if conn is <0. Defaults to "::" (any
  52    * address). */
  53   char *node;
  54
  55   /* service is the local address to listen on if conn is <0. Defaults to
  56    * LCC_DEFAULT_PORT. */
  57   char *service;
  58
  59   /* writer is the callback used to send incoming lcc_value_list_t to. */
  60   lcc_value_list_writer_t writer;
  61
  62   /* buffer_size determines the maximum packet size to accept. */
  63   uint16_t buffer_size;
  64
  65   /* password_lookup is used to look up the password for a given username. */
  66   lcc_password_lookup_t password_lookup;
  67
  68   /* security_level is the minimal required security level. */
  69   lcc_security_level_t security_level;
  70
  71   /* interface is the name of the interface to use when subscribing to a
  72    * multicast group. Has no effect when using unicast. */
  73   char *interface;
  74 } lcc_listener_t;
  75
  76 /* lcc_listen_and_write listens on the provided UDP socket (or opens one using
  77  * srv.addr if srv.conn is less than zero), parses the received packets and
  78  * writes them to the provided lcc_value_list_writer_t. Returns non-zero on
  79  * failure and does not return otherwise. */
  80 int lcc_listen_and_write(lcc_listener_t srv);
  81
  82 typedef struct {
  83   /* writer is the callback used to send incoming lcc_value_list_t to. */
  84   lcc_value_list_writer_t writer;
  85
  86   /* password_lookup is used to look up the password for a given username. */
  87   lcc_password_lookup_t password_lookup;
  88
  89   /* security_level is the minimal required security level. */
  90   lcc_security_level_t security_level;
  91 } lcc_network_parse_options_t;
  92
  93 /* lcc_network_parse parses data received from the network and calls "w" with
  94  * the parsed lcc_value_list_ts. */
  95 /* TODO(octo): the Go code returns a []api.ValueList. Should we return a
  96  * value_list_t** here? */
  97 int lcc_network_parse(void *buffer, size_t buffer_size,
  98                       lcc_network_parse_options_t opts);
  99
 100 LCC_END_DECLS
 101
 102 #endif /* LIBCOLLECTD_SERVER_H */