2 This file is part of GNUnet.
3 Copyright (C) 2009, 2010, 2012, 2013, 2016 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file arm/arm_monitor_api.c
23 * @brief API for monitoring the ARM service
24 * @author Christian Grothoff
28 #include "gnunet_arm_service.h"
29 #include "gnunet_util_lib.h"
30 #include "gnunet_protocols.h"
33 #define INIT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
35 #define LOG(kind,...) GNUNET_log_from (kind, "arm-monitor-api",__VA_ARGS__)
38 * Handle for interacting with ARM.
40 struct GNUNET_ARM_MonitorHandle
44 * Our control connection to the ARM service.
46 struct GNUNET_MQ_Handle *mq;
49 * The configuration that we are using.
51 const struct GNUNET_CONFIGURATION_Handle *cfg;
54 * ID of the reconnect task (if any).
56 struct GNUNET_SCHEDULER_Task *reconnect_task;
59 * Current delay we use for re-trying to connect to core.
61 struct GNUNET_TIME_Relative retry_backoff;
64 * Callback to invoke on status updates.
66 GNUNET_ARM_ServiceStatusCallback service_status;
69 * Closure for @e service_status.
71 void *service_status_cls;
77 * Connect to the ARM service for monitoring.
79 * @param h handle to connect
80 * @return #GNUNET_OK on success
83 reconnect_arm_monitor (struct GNUNET_ARM_MonitorHandle *h);
87 * Task scheduled to try to re-connect to arm.
89 * @param cls the `struct GNUNET_ARM_MonitorHandle`
92 reconnect_arm_monitor_task (void *cls)
94 struct GNUNET_ARM_MonitorHandle *h = cls;
96 h->reconnect_task = NULL;
97 LOG (GNUNET_ERROR_TYPE_DEBUG,
98 "Connecting to ARM service for monitoring after delay\n");
99 GNUNET_break (GNUNET_OK == reconnect_arm_monitor (h));
104 * Close down any existing connection to the ARM service and
105 * try re-establishing it later.
107 * @param h our handle
110 reconnect_arm_monitor_later (struct GNUNET_ARM_MonitorHandle *h)
114 GNUNET_MQ_destroy (h->mq);
117 GNUNET_assert (NULL == h->reconnect_task);
119 = GNUNET_SCHEDULER_add_delayed (h->retry_backoff,
120 &reconnect_arm_monitor_task, h);
121 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
126 * Check notification messages received from ARM is well-formed.
128 * @param cls our `struct GNUNET_ARM_MonitorHandle`
129 * @param msg the message received from the arm service
130 * @return #GNUNET_OK if the message is well-formed
133 check_monitor_notify (void *cls,
134 const struct GNUNET_ARM_StatusMessage *msg)
136 size_t sl = ntohs (msg->header.size) - sizeof (struct GNUNET_ARM_StatusMessage);
137 const char *name = (const char *) &msg[1];
140 ('\0' != name[sl-1]) )
143 return GNUNET_SYSERR;
150 * Handler for notification messages received from ARM.
152 * @param cls our `struct GNUNET_ARM_MonitorHandle`
153 * @param res the message received from the arm service
156 handle_monitor_notify (void *cls,
157 const struct GNUNET_ARM_StatusMessage *res)
159 struct GNUNET_ARM_MonitorHandle *h = cls;
160 enum GNUNET_ARM_ServiceStatus status;
162 status = (enum GNUNET_ARM_ServiceStatus) ntohl (res->status);
163 LOG (GNUNET_ERROR_TYPE_DEBUG,
164 "Received notification from ARM for service `%s' with status %d\n",
165 (const char *) &res[1],
167 if (NULL != h->service_status)
168 h->service_status (h->service_status_cls,
169 (const char *) &res[1],
175 * Generic error handler, called with the appropriate error code and
176 * the same closure specified at the creation of the message queue.
177 * Not every message queue implementation supports an error handler.
179 * @param cls closure with the `struct GNUNET_ARM_MonitorHandle *`
180 * @param error error code
183 mq_error_handler (void *cls,
184 enum GNUNET_MQ_Error error)
186 struct GNUNET_ARM_MonitorHandle *h = cls;
188 reconnect_arm_monitor_later (h);
193 * Connect to the ARM service for monitoring.
195 * @param h handle to connect
196 * @return #GNUNET_OK on success
199 reconnect_arm_monitor (struct GNUNET_ARM_MonitorHandle *h)
201 struct GNUNET_MQ_MessageHandler handlers[] = {
202 GNUNET_MQ_hd_var_size (monitor_notify,
203 GNUNET_MESSAGE_TYPE_ARM_STATUS,
204 struct GNUNET_ARM_StatusMessage,
206 GNUNET_MQ_handler_end ()
208 struct GNUNET_MessageHeader *msg;
209 struct GNUNET_MQ_Envelope *env;
211 GNUNET_assert (NULL == h->mq);
212 h->mq = GNUNET_CLIENT_connect (h->cfg,
219 if (NULL != h->service_status)
220 h->service_status (h->service_status_cls,
222 GNUNET_ARM_SERVICE_STOPPED);
223 return GNUNET_SYSERR;
225 env = GNUNET_MQ_msg (msg,
226 GNUNET_MESSAGE_TYPE_ARM_MONITOR);
227 GNUNET_MQ_send (h->mq,
234 * Setup a context for monitoring ARM, then
235 * start connecting to the ARM service for monitoring using that context.
237 * @param cfg configuration to use (needed to contact ARM;
238 * the ARM service may internally use a different
239 * configuration to determine how to start the service).
240 * @param cont callback to invoke on status updates
241 * @param cont_cls closure for @a cont
242 * @return context to use for further ARM monitor operations, NULL on error.
244 struct GNUNET_ARM_MonitorHandle *
245 GNUNET_ARM_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
246 GNUNET_ARM_ServiceStatusCallback cont,
249 struct GNUNET_ARM_MonitorHandle *h;
251 h = GNUNET_new (struct GNUNET_ARM_MonitorHandle);
253 h->service_status = cont;
254 h->service_status_cls = cont_cls;
255 if (GNUNET_OK != reconnect_arm_monitor (h))
265 * Disconnect from the ARM service (if connected) and destroy the context.
267 * @param h the handle that was being used
270 GNUNET_ARM_monitor_stop (struct GNUNET_ARM_MonitorHandle *h)
274 GNUNET_MQ_destroy (h->mq);
277 if (NULL != h->reconnect_task)
279 GNUNET_SCHEDULER_cancel (h->reconnect_task);
280 h->reconnect_task = NULL;
286 /* end of arm_api.c */