mon/tr_mon_req.h

   1 /*
   2  * Copyright (c) 2018, JANET(UK)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. Neither the name of JANET(UK) nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  25  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  26  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  27  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  29  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  31  * OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35
  36 #ifndef TRUST_ROUTER_TR_MON_REQ_H
  37 #define TRUST_ROUTER_TR_MON_REQ_H
  38
  39 #include <talloc.h>
  40 #include <jansson.h>
  41 #include <gmodule.h>
  42
  43 /* Typedefs */
  44 typedef struct tr_mon_req TR_MON_REQ;
  45
  46 typedef enum tr_mon_cmd TR_MON_CMD;
  47
  48 typedef struct tr_mon_opt TR_MON_OPT;
  49 typedef enum tr_mon_opt_type TR_MON_OPT_TYPE;
  50
  51 typedef enum tr_mon_rc TR_MON_RC;
  52
  53
  54 /* Struct and enum definitions */
  55 enum tr_mon_rc {
  56   TR_MON_SUCCESS=0,
  57   TR_MON_ERROR, /* generic error */
  58   TR_MON_BADARG, /* problem with the arguments */
  59   TR_MON_NOMEM, /* out of memory */
  60   TR_MON_NOPARSE, /* parsing failed */
  61 };
  62
  63 enum tr_mon_cmd {
  64   MON_CMD_UNKNOWN=0,
  65   MON_CMD_RECONFIGURE,
  66   MON_CMD_SHOW
  67 };
  68
  69 enum tr_mon_opt_type {
  70   OPT_TYPE_UNKNOWN=0,
  71
  72   // System information
  73   OPT_TYPE_SHOW_VERSION,
  74   OPT_TYPE_SHOW_SERIAL,
  75
  76   // System statistics
  77   OPT_TYPE_SHOW_UPTIME,
  78   OPT_TYPE_SHOW_TID_REQ_COUNT,
  79   OPT_TYPE_SHOW_TID_REQ_PENDING,
  80
  81   // Dynamic trust router state
  82   OPT_TYPE_SHOW_ROUTES,
  83   OPT_TYPE_SHOW_COMMUNITIES
  84 };
  85
  86 struct tr_mon_opt {
  87   TR_MON_OPT_TYPE type;
  88 };
  89
  90 struct tr_mon_req {
  91   TR_MON_CMD command;
  92   GArray *options;
  93 };
  94
  95 /* Prototypes */
  96 TR_MON_REQ *tr_mon_req_new(TALLOC_CTX *mem_ctx, TR_MON_CMD cmd);
  97 void tr_mon_req_free(TR_MON_REQ *req);
  98 TR_MON_RC tr_mon_req_add_option(TR_MON_REQ *req, TR_MON_OPT_TYPE opt_type);
  99 size_t tr_mon_req_opt_count(TR_MON_REQ *req);
 100 TR_MON_OPT *tr_mon_req_opt_index(TR_MON_REQ *req, size_t index);
 101
 102 const char *cmd_to_string(TR_MON_CMD cmd);
 103 TR_MON_CMD cmd_from_string(const char *s);
 104
 105 const char *opt_type_to_string(TR_MON_OPT_TYPE opt_type);
 106 TR_MON_OPT_TYPE opt_type_from_string(const char *s);
 107
 108 /* tr_mon_req_encode.c */
 109 json_t *tr_mon_req_encode(TR_MON_REQ *req);
 110
 111 /* tr_mon_req_decode.c */
 112 TR_MON_REQ *tr_mon_req_decode(TALLOC_CTX *mem_ctx, const char *req_json);
 113
 114 /* tr_mon_rec_decode.c */
 115
 116 #endif //TRUST_ROUTER_TR_MON_REQ_H