2 * Copyright (c) 2018, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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.
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.
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.
40 #include "tr_mon_req.h"
42 // Monitoring request message common code
45 * Destructor used by talloc to ensure proper cleanup
47 static int tr_mon_req_destructor(void *object)
49 TR_MON_REQ *req = talloc_get_type_abort(object, TR_MON_REQ);
51 g_array_unref(req->options);
57 * Allocate a new monitoring request
59 * @param mem_ctx talloc context for the new request
60 * @param cmd command for the request
61 * @return newly allocated request, or null on error
63 TR_MON_REQ *tr_mon_req_new(TALLOC_CTX *mem_ctx, TR_MON_CMD cmd)
65 TR_MON_REQ *req=talloc(mem_ctx, TR_MON_REQ);
68 req->options = g_array_new(FALSE, FALSE, sizeof(TR_MON_OPT));
69 talloc_set_destructor((void *)req, tr_mon_req_destructor);
75 * Free a monitoring request
77 * @param req request to free, must not be null
79 void tr_mon_req_free(TR_MON_REQ *req)
85 * Add an option to a TR_MON_REQ
86 * @param req request to operate on, not null
87 * @param opt_type type of option
88 * @return TR_MON_SUCCESS on success, error code on error
90 TR_MON_RC tr_mon_req_add_option(TR_MON_REQ *req, TR_MON_OPT_TYPE opt_type)
92 TR_MON_OPT new_opt; // not a pointer
94 /* Validate parameters */
95 if ((req == NULL) || (opt_type == OPT_TYPE_UNKNOWN)) {
99 new_opt.type = opt_type;
101 /* Add the new option to the list */
102 g_array_append_val(req->options, new_opt);
103 return TR_MON_SUCCESS;
106 size_t tr_mon_req_opt_count(TR_MON_REQ *req)
108 return req->options->len;
111 TR_MON_OPT *tr_mon_req_opt_index(TR_MON_REQ *req, size_t index)
113 TR_MON_OPT *result = (TR_MON_OPT *) &g_array_index(req->options, TR_MON_OPT, index);
118 * This method defines the command strings
120 const char *cmd_to_string(TR_MON_CMD cmd)
123 case MON_CMD_UNKNOWN:
126 case MON_CMD_RECONFIGURE:
127 return "reconfigure";
135 // Helper macro for the cmd_from_string method
136 #define return_if_matches(s, cmd) \
138 if (strcmp((s), cmd_to_string(cmd))==0) \
142 TR_MON_CMD cmd_from_string(const char *s)
144 return_if_matches(s, MON_CMD_RECONFIGURE);
145 return_if_matches(s, MON_CMD_SHOW);
146 return MON_CMD_UNKNOWN;
148 #undef return_if_matches
151 * This method defines the option type strings
153 const char *opt_type_to_string(TR_MON_OPT_TYPE opt_type)
156 case OPT_TYPE_UNKNOWN:
159 case OPT_TYPE_SHOW_VERSION:
162 case OPT_TYPE_SHOW_SERIAL:
165 case OPT_TYPE_SHOW_UPTIME:
168 case OPT_TYPE_SHOW_TID_REQ_COUNT:
169 return "tid_req_count";
171 case OPT_TYPE_SHOW_TID_REQ_PENDING:
172 return "tid_req_pending";
174 case OPT_TYPE_SHOW_ROUTES:
177 case OPT_TYPE_SHOW_COMMUNITIES:
178 return "communities";
183 // Helper macro for the opt_type_from_string method
184 #define return_if_matches(s, cmd) \
186 if (strcmp((s), opt_type_to_string(cmd))==0) \
190 TR_MON_OPT_TYPE opt_type_from_string(const char *s)
192 return_if_matches(s, OPT_TYPE_SHOW_VERSION);
193 return_if_matches(s, OPT_TYPE_SHOW_SERIAL);
194 return_if_matches(s, OPT_TYPE_SHOW_UPTIME);
195 return_if_matches(s, OPT_TYPE_SHOW_TID_REQ_COUNT);
196 return_if_matches(s, OPT_TYPE_SHOW_TID_REQ_PENDING);
197 return_if_matches(s, OPT_TYPE_SHOW_ROUTES);
198 return_if_matches(s, OPT_TYPE_SHOW_COMMUNITIES);
199 return OPT_TYPE_UNKNOWN;
201 #undef return_if_matches