2 This file is part of GNUnet.
3 Copyright (C) 2009, 2010, 2012, 2013 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file arm/arm_monitor_api.c
23 * @brief API for monitoring the ARM service
24 * @author Christian Grothoff, LRN
27 #include "gnunet_arm_service.h"
28 #include "gnunet_util_lib.h"
29 #include "gnunet_protocols.h"
32 #define INIT_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
34 #define LOG(kind,...) GNUNET_log_from (kind, "arm-monitor-api",__VA_ARGS__)
37 * Handle for interacting with ARM.
39 struct GNUNET_ARM_MonitorHandle
43 * Our control connection to the ARM service.
45 struct GNUNET_CLIENT_Connection *monitor;
48 * The configuration that we are using.
50 struct GNUNET_CONFIGURATION_Handle *cfg;
53 * Handle for our current transmission request.
55 struct GNUNET_CLIENT_TransmitHandle *cth;
58 * ID of the reconnect task (if any).
60 struct GNUNET_SCHEDULER_Task * reconnect_task;
63 * Current delay we use for re-trying to connect to core.
65 struct GNUNET_TIME_Relative retry_backoff;
68 * Are we currently disconnected and hence unable to send?
70 unsigned char currently_down;
73 * Callback to invoke on status updates.
75 GNUNET_ARM_ServiceStatusCallback service_status;
78 * Closure for service_status.
83 * ID of a task to run if we fail to get a reply to the init message in time.
85 struct GNUNET_SCHEDULER_Task * init_timeout_task_id;
90 monitor_notify_handler (void *cls,
91 const struct GNUNET_MessageHeader *msg);
95 reconnect_arm_monitor (struct GNUNET_ARM_MonitorHandle *h);
99 * Task scheduled to try to re-connect to arm.
101 * @param cls the 'struct GNUNET_ARM_MonitorHandle'
104 reconnect_arm_monitor_task (void *cls)
106 struct GNUNET_ARM_MonitorHandle *h = cls;
108 h->reconnect_task = NULL;
109 LOG (GNUNET_ERROR_TYPE_DEBUG,
110 "Connecting to ARM service for monitoring after delay\n");
111 reconnect_arm_monitor (h);
116 * Close down any existing connection to the ARM service and
117 * try re-establishing it later.
119 * @param h our handle
122 reconnect_arm_monitor_later (struct GNUNET_ARM_MonitorHandle *h)
126 GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
130 if (NULL != h->monitor)
132 GNUNET_CLIENT_disconnect (h->monitor);
136 if (NULL != h->init_timeout_task_id)
138 GNUNET_SCHEDULER_cancel (h->init_timeout_task_id);
139 h->init_timeout_task_id = NULL;
142 GNUNET_assert (NULL == h->reconnect_task);
144 GNUNET_SCHEDULER_add_delayed (h->retry_backoff, &reconnect_arm_monitor_task, h);
146 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
151 * Init message timed out. Disconnect and try again.
153 * @param cls arm monitor handle
156 init_timeout_task (void *cls)
158 struct GNUNET_ARM_MonitorHandle *h = cls;
160 LOG (GNUNET_ERROR_TYPE_DEBUG,
161 "Init message timed out\n");
162 h->init_timeout_task_id = NULL;
163 reconnect_arm_monitor_later (h);
168 * Transmit the monitoring initialization message to the arm service.
170 * @param cls closure with the 'struct GNUNET_ARM_MonitorHandle'
171 * @param size number of bytes available in buf
172 * @param buf where the callee should write the message
173 * @return number of bytes written to buf
176 transmit_monitoring_init_message (void *cls, size_t size, void *buf)
178 struct GNUNET_ARM_MonitorHandle *h = cls;
179 struct GNUNET_MessageHeader *msg;
182 GNUNET_assert (NULL == h->reconnect_task);
183 GNUNET_assert (NULL == h->init_timeout_task_id);
187 LOG (GNUNET_ERROR_TYPE_DEBUG,
188 "Transmission failed, initiating reconnect\n");
189 reconnect_arm_monitor_later (h);
192 msize = sizeof (struct GNUNET_MessageHeader);
195 LOG (GNUNET_ERROR_TYPE_DEBUG,
196 "Request is too big (%u < %u), not sending it\n", size, msize);
197 h->cth = GNUNET_CLIENT_notify_transmit_ready (h->monitor, msize,
198 GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_NO,
199 transmit_monitoring_init_message, h);
204 msg->size = htons (msize);
205 msg->type = htons (GNUNET_MESSAGE_TYPE_ARM_MONITOR);
206 LOG (GNUNET_ERROR_TYPE_DEBUG,
207 "Transmitting ARM monitoring init message with %u bytes to arm.\n",
208 (unsigned int) msize);
210 h->init_timeout_task_id = GNUNET_SCHEDULER_add_delayed (
211 INIT_TIMEOUT, init_timeout_task, h);
212 GNUNET_CLIENT_receive (h->monitor, &monitor_notify_handler, h,
213 GNUNET_TIME_UNIT_FOREVER_REL);
219 reconnect_arm_monitor (struct GNUNET_ARM_MonitorHandle *h)
221 GNUNET_assert (NULL == h->monitor);
222 h->monitor = GNUNET_CLIENT_connect ("arm", h->cfg);
223 if (NULL == h->monitor)
225 LOG (GNUNET_ERROR_TYPE_DEBUG,
226 "arm_api, GNUNET_CLIENT_connect returned NULL\n");
227 if (NULL != h->service_status)
228 h->service_status (h->cls, NULL, GNUNET_ARM_SERVICE_STOPPED);
229 return GNUNET_SYSERR;
231 LOG (GNUNET_ERROR_TYPE_DEBUG,
232 "arm_api, GNUNET_CLIENT_connect returned non-NULL\n");
233 h->cth = GNUNET_CLIENT_notify_transmit_ready (h->monitor,
234 sizeof (struct GNUNET_MessageHeader), GNUNET_TIME_UNIT_FOREVER_REL,
235 GNUNET_NO, &transmit_monitoring_init_message, h);
241 * Setup a context for monitoring ARM, then
242 * start connecting to the ARM service for monitoring using that context.
244 * @param cfg configuration to use (needed to contact ARM;
245 * the ARM service may internally use a different
246 * configuration to determine how to start the service).
247 * @param cont callback to invoke on status updates
248 * @param cont_cls closure
249 * @return context to use for further ARM monitor operations, NULL on error.
251 struct GNUNET_ARM_MonitorHandle *
252 GNUNET_ARM_monitor (const struct GNUNET_CONFIGURATION_Handle *cfg,
253 GNUNET_ARM_ServiceStatusCallback cont, void *cont_cls)
255 struct GNUNET_ARM_MonitorHandle *h;
257 h = GNUNET_new (struct GNUNET_ARM_MonitorHandle);
258 h->cfg = GNUNET_CONFIGURATION_dup (cfg);
259 h->currently_down = GNUNET_YES;
260 h->reconnect_task = NULL;
261 h->init_timeout_task_id = NULL;
262 h->service_status = cont;
264 if (GNUNET_OK != reconnect_arm_monitor (h))
274 * Disconnect from the ARM service (if connected) and destroy the context.
276 * @param h the handle that was being used
279 GNUNET_ARM_monitor_disconnect_and_free (struct GNUNET_ARM_MonitorHandle *h)
281 LOG (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting from ARM service\n");
284 GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
287 if (NULL != h->init_timeout_task_id)
289 GNUNET_SCHEDULER_cancel (h->init_timeout_task_id);
290 h->init_timeout_task_id = NULL;
292 if (NULL != h->monitor)
294 GNUNET_CLIENT_disconnect (h->monitor);
297 if (NULL != h->reconnect_task)
299 GNUNET_SCHEDULER_cancel (h->reconnect_task);
300 h->reconnect_task = NULL;
302 GNUNET_CONFIGURATION_destroy (h->cfg);
308 * Handler for notification messages received from ARM.
310 * @param cls our "struct GNUNET_ARM_MonitorHandle"
311 * @param msg the message received from the arm service
314 monitor_notify_handler (void *cls, const struct GNUNET_MessageHeader *msg)
316 struct GNUNET_ARM_MonitorHandle *h = cls;
318 const struct GNUNET_ARM_StatusMessage *res;
319 enum GNUNET_ARM_ServiceStatus status;
323 LOG (GNUNET_ERROR_TYPE_INFO,
324 _("Monitoring client was disconnected from arm service, trying to reconnect.\n"));
325 reconnect_arm_monitor_later (h);
328 msize = ntohs (msg->size);
329 LOG (GNUNET_ERROR_TYPE_DEBUG,
330 "Processing message of type %u and size %u from arm service\n",
331 ntohs (msg->type), msize);
332 switch (ntohs (msg->type))
334 case GNUNET_MESSAGE_TYPE_ARM_STATUS:
335 if (msize <= sizeof (struct GNUNET_ARM_StatusMessage))
338 reconnect_arm_monitor_later (h);
341 if (NULL != h->init_timeout_task_id)
343 GNUNET_SCHEDULER_cancel (h->init_timeout_task_id);
344 h->init_timeout_task_id = NULL;
346 res = (const struct GNUNET_ARM_StatusMessage *) msg;
347 LOG (GNUNET_ERROR_TYPE_DEBUG,
348 "Received response from ARM for service `%s': %u\n",
349 (const char *) &res[1], ntohs (msg->type));
350 status = (enum GNUNET_ARM_ServiceStatus) ntohl (res->status);
351 GNUNET_CLIENT_receive (h->monitor, &monitor_notify_handler, h,
352 GNUNET_TIME_UNIT_FOREVER_REL);
353 if (NULL != h->service_status)
354 h->service_status (h->cls, (const char *) &res[1], status);
357 reconnect_arm_monitor_later (h);
363 /* end of arm_api.c */