2 This file is part of GNUnet.
3 (C) 2009, 2010, 2012, 2013 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
23 * @brief API for accessing 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 LOG(kind,...) GNUNET_log_from (kind, "arm-api",__VA_ARGS__)
35 * Handle for interacting with ARM.
37 struct GNUNET_ARM_Handle
40 * Our control connection to the ARM service.
42 struct GNUNET_CLIENT_Connection *client;
45 * The configuration that we are using.
47 struct GNUNET_CONFIGURATION_Handle *cfg;
50 * Handle for our current transmission request.
52 struct GNUNET_CLIENT_TransmitHandle *cth;
55 * Head of doubly-linked list of pending requests.
57 struct ARMControlMessage *control_pending_head;
60 * Tail of doubly-linked list of pending requests.
62 struct ARMControlMessage *control_pending_tail;
65 * Head of doubly-linked list of sent requests.
67 struct ARMControlMessage *control_sent_head;
70 * Tail of doubly-linked list of sent requests.
72 struct ARMControlMessage *control_sent_tail;
75 * ID of the reconnect task (if any).
77 GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
80 * Current delay we use for re-trying to connect to core.
82 struct GNUNET_TIME_Relative retry_backoff;
85 * Callback to invoke on connection/disconnection.
87 GNUNET_ARM_ConnectionStatusCallback conn_status;
90 * Closure for conn_status.
92 void *conn_status_cls;
95 * Counter for request identifiers
97 uint64_t request_id_counter;
100 * Are we currently disconnected and hence unable to send?
102 unsigned char currently_down;
105 * GNUNET_YES if we're running a service test.
107 unsigned char service_test_is_active;
112 * Entry in a doubly-linked list of control messages to be transmitted
113 * to the arm service.
115 * The actual message is allocated at the end of this struct.
117 struct ARMControlMessage
120 * This is a doubly-linked list.
122 struct ARMControlMessage *next;
125 * This is a doubly-linked list.
127 struct ARMControlMessage *prev;
132 struct GNUNET_ARM_Handle *h;
137 struct GNUNET_ARM_Message *msg;
140 * Callback for service state change requests.
142 GNUNET_ARM_ResultCallback result_cont;
145 * Callback for service list requests.
147 GNUNET_ARM_ServiceListCallback list_cont;
150 * Closure for 'result_cont' or 'list_cont'.
155 * Timeout for the operation.
157 struct GNUNET_TIME_Absolute timeout;
160 * Flags for passing std descriptors to ARM (when starting ARM).
162 enum GNUNET_OS_InheritStdioFlags std_inheritance;
165 * Task to run when request times out.
167 GNUNET_SCHEDULER_TaskIdentifier timeout_task_id;
170 * Type of the request expressed as a message type (start, stop or list).
176 client_notify_handler (void *cls, const struct GNUNET_MessageHeader *msg);
179 reconnect_arm (struct GNUNET_ARM_Handle *h);
182 trigger_next_request (struct GNUNET_ARM_Handle *h, int ignore_currently_down);
186 * Task scheduled to try to re-connect to arm.
188 * @param cls the 'struct GNUNET_ARM_Handle'
189 * @param tc task context
192 reconnect_arm_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
194 struct GNUNET_ARM_Handle *h = cls;
196 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
197 LOG (GNUNET_ERROR_TYPE_DEBUG, "Connecting to ARM service after delay\n");
203 clear_pending_messages (struct GNUNET_ARM_Handle *h, enum GNUNET_ARM_RequestStatus result)
205 struct ARMControlMessage *cm;
207 LOG (GNUNET_ERROR_TYPE_DEBUG,
208 "Clearing pending messages\n");
210 while (NULL != (cm = h->control_pending_head))
212 GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
213 h->control_pending_tail, cm);
214 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != cm->timeout_task_id);
215 GNUNET_SCHEDULER_cancel (cm->timeout_task_id);
216 if (NULL != cm->result_cont)
217 cm->result_cont (cm->cont_cls, cm->h, result, NULL, 0);
218 GNUNET_free_non_null (cm->msg);
224 * Close down any existing connection to the ARM service and
225 * try re-establishing it later.
227 * @param h our handle
230 reconnect_arm_later (struct GNUNET_ARM_Handle *h)
232 if (GNUNET_NO != h->currently_down)
236 GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
239 if (NULL != h->client)
241 GNUNET_CLIENT_disconnect (h->client);
244 h->currently_down = GNUNET_YES;
245 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task);
247 GNUNET_SCHEDULER_add_delayed (h->retry_backoff, &reconnect_arm_task, h);
248 /* Don't clear pending messages on disconnection, deliver them later
249 clear_pending_messages (h, GNUNET_ARM_REQUEST_DISCONNECTED);
250 GNUNET_assert (NULL == h->control_pending_head);
252 h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
253 if (NULL != h->conn_status)
254 h->conn_status (h->conn_status_cls, h, GNUNET_NO);
258 * Transmit the next message to the arm service.
260 * @param cls closure with the 'struct GNUNET_ARM_Handle'
261 * @param size number of bytes available in buf
262 * @param buf where the callee should write the message
263 * @return number of bytes written to buf
266 transmit_arm_message (void *cls, size_t size, void *buf)
268 struct GNUNET_ARM_Handle *h = cls;
269 struct ARMControlMessage *cm;
270 struct GNUNET_ARM_Message *arm_msg;
272 int notify_connection;
275 notify_connection = GNUNET_NO;
276 LOG (GNUNET_ERROR_TYPE_DEBUG,
277 "transmit_arm_message is running with %p buffer of size %lu. ARM is known to be %s\n",
278 buf, size, h->currently_down ? "unconnected" : "connected");
279 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == h->reconnect_task);
281 if ((GNUNET_YES == h->currently_down) && (NULL != buf))
283 h->currently_down = GNUNET_NO;
284 notify_connection = GNUNET_YES;
285 h->retry_backoff = GNUNET_TIME_UNIT_MILLISECONDS;
286 GNUNET_CLIENT_receive (h->client, &client_notify_handler, h,
287 GNUNET_TIME_UNIT_FOREVER_REL);
291 LOG (GNUNET_ERROR_TYPE_DEBUG,
292 "Transmission failed, initiating reconnect\n");
293 reconnect_arm_later (h);
296 if (NULL == (cm = h->control_pending_head))
298 LOG (GNUNET_ERROR_TYPE_DEBUG, "Queue is empty, not sending anything\n");
302 GNUNET_assert (NULL != cm->msg);
303 msize = ntohs (cm->msg->header.size);
306 LOG (GNUNET_ERROR_TYPE_DEBUG,
307 "Request is too big (%u < %u), not sending it\n", size, msize);
308 trigger_next_request (h, GNUNET_NO);
313 if (0 == h->request_id_counter)
314 h->request_id_counter++;
315 request_id = h->request_id_counter++;
316 LOG (GNUNET_ERROR_TYPE_DEBUG,
317 "Transmitting control message with %u bytes of type %u to arm with id %llu\n",
318 (unsigned int) msize, (unsigned int) ntohs (cm->msg->header.type), request_id);
319 arm_msg->request_id = GNUNET_htonll (request_id);
320 memcpy (buf, cm->msg, msize);
321 /* Otherwise we won't be able to find it later! */
322 arm_msg->request_id = request_id;
323 GNUNET_CONTAINER_DLL_remove (h->control_pending_head,
324 h->control_pending_tail, cm);
325 GNUNET_CONTAINER_DLL_insert_tail (h->control_sent_head,
326 h->control_sent_tail, cm);
327 /* Don't free msg, keep it around (kind of wasteful, but then we don't
328 * really have many messages to handle, and it'll be freed when it times
331 trigger_next_request (h, GNUNET_NO);
334 if ((GNUNET_YES == notify_connection) && (NULL != h->conn_status))
335 h->conn_status (h->conn_status_cls, h, GNUNET_YES);
341 * Check the list of pending requests, send the next
344 * @param h arm handle
345 * @param ignore_currently_down transmit message even if not initialized?
348 trigger_next_request (struct GNUNET_ARM_Handle *h, int ignore_currently_down)
352 msize = sizeof (struct GNUNET_MessageHeader);
353 if ((GNUNET_YES == h->currently_down) && (ignore_currently_down == GNUNET_NO))
355 LOG (GNUNET_ERROR_TYPE_DEBUG,
356 "ARM connection down, not processing queue\n");
361 LOG (GNUNET_ERROR_TYPE_DEBUG, "Request pending, not processing queue\n");
364 if (NULL != h->control_pending_head)
366 ntohs (((struct GNUNET_MessageHeader *) &h->
367 control_pending_head[1])->size);
368 else if (GNUNET_NO == ignore_currently_down)
370 LOG (GNUNET_ERROR_TYPE_DEBUG,
371 "Request queue empty, not processing queue\n");
372 return; /* no pending message */
375 GNUNET_CLIENT_notify_transmit_ready (h->client, msize,
376 GNUNET_TIME_UNIT_FOREVER_REL,
377 GNUNET_NO, &transmit_arm_message, h);
384 * @param h arm handle
387 reconnect_arm (struct GNUNET_ARM_Handle *h)
389 GNUNET_assert (NULL == h->client);
390 GNUNET_assert (GNUNET_YES == h->currently_down);
391 h->client = GNUNET_CLIENT_connect ("arm", h->cfg);
392 if (NULL == h->client)
394 LOG (GNUNET_ERROR_TYPE_DEBUG,
395 "arm_api, GNUNET_CLIENT_connect returned NULL\n");
396 if (NULL != h->conn_status)
397 h->conn_status (h->conn_status_cls, h, GNUNET_SYSERR);
398 return GNUNET_SYSERR;
400 LOG (GNUNET_ERROR_TYPE_DEBUG,
401 "arm_api, GNUNET_CLIENT_connect returned non-NULL\n");
402 trigger_next_request (h, GNUNET_YES);
408 * Set up a context for communicating with ARM, then
409 * start connecting to the ARM service using that context.
411 * @param cfg configuration to use (needed to contact ARM;
412 * the ARM service may internally use a different
413 * configuration to determine how to start the service).
414 * @param conn_status will be called when connecting/disconnecting
415 * @param cls closure for conn_status
416 * @return context to use for further ARM operations, NULL on error.
418 struct GNUNET_ARM_Handle *
419 GNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
420 GNUNET_ARM_ConnectionStatusCallback conn_status, void *cls)
422 struct GNUNET_ARM_Handle *h;
424 h = GNUNET_malloc (sizeof (struct GNUNET_ARM_Handle));
425 h->cfg = GNUNET_CONFIGURATION_dup (cfg);
426 h->currently_down = GNUNET_YES;
427 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
428 h->conn_status = conn_status;
429 h->conn_status_cls = cls;
430 if (GNUNET_OK != reconnect_arm (h))
440 * Disconnect from the ARM service (if connected) and destroy the context.
442 * @param h the handle that was being used
445 GNUNET_ARM_disconnect_and_free (struct GNUNET_ARM_Handle *h)
447 LOG (GNUNET_ERROR_TYPE_DEBUG, "Disconnecting from ARM service\n");
450 GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
453 clear_pending_messages (h, GNUNET_ARM_REQUEST_DISCONNECTED);
454 if (NULL != h->client)
456 GNUNET_CLIENT_disconnect (h->client);
459 if (GNUNET_SCHEDULER_NO_TASK != h->reconnect_task)
461 GNUNET_SCHEDULER_cancel (h->reconnect_task);
462 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
464 if (GNUNET_NO == h->service_test_is_active)
466 GNUNET_CONFIGURATION_destroy (h->cfg);
473 * Message timed out. Remove it from the queue.
475 * @param cls the message (struct ARMControlMessage *)
476 * @param tc task context
479 control_message_timeout (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
481 struct ARMControlMessage *cm = cls;
482 struct GNUNET_ARM_Message *arm_msg;
483 LOG (GNUNET_ERROR_TYPE_DEBUG,
484 "Control message timed out\n");
486 if ((NULL == arm_msg) || (0 == arm_msg->request_id))
488 GNUNET_CONTAINER_DLL_remove (cm->h->control_pending_head,
489 cm->h->control_pending_tail, cm);
493 GNUNET_CONTAINER_DLL_remove (cm->h->control_sent_head,
494 cm->h->control_sent_tail, cm);
496 if (NULL != cm->result_cont)
497 cm->result_cont (cm->cont_cls, cm->h, GNUNET_ARM_REQUEST_TIMEOUT, NULL, 0);
498 else if (NULL != cm->list_cont)
499 cm->list_cont (cm->cont_cls, cm->h, GNUNET_ARM_REQUEST_TIMEOUT, 0, NULL);
500 GNUNET_free_non_null (cm->msg);
505 #include "do_start_process.c"
509 * A client specifically requested starting of ARM itself.
510 * This function is called with information about whether
511 * or not ARM is running; if it is, report success. If
512 * it is not, start the ARM process.
514 * @param cls the context for the request that we will report on (struct ARMControlMessage *)
515 * @param tc why were we called (reason says if ARM is running)
518 arm_service_report (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
520 struct ARMControlMessage *cm = cls;
521 struct GNUNET_ARM_Handle *h;
522 struct GNUNET_OS_Process *proc;
523 unsigned char test_is_active;
530 test_is_active = cm->h->service_test_is_active;
532 /* FIXME: shouldn't we check for GNUNET_SCHEDULER_REASON_SHUTDOWN ? */
533 if ((GNUNET_YES == test_is_active) &&
534 (0 != (tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE)))
536 LOG (GNUNET_ERROR_TYPE_DEBUG, "Looks like `%s' is already running.\n",
537 "gnunet-service-arm");
538 /* arm is running! */
540 cm->result_cont (cm->cont_cls, cm->h, GNUNET_ARM_REQUEST_SENT_OK, "arm", GNUNET_ARM_RESULT_IS_STARTED_ALREADY);
542 if (GNUNET_NO == test_is_active)
544 /* User disconnected & destroyed ARM handle in the middle of
545 * the service test, so we kept the handle around until now.
547 GNUNET_CONFIGURATION_destroy (cm->h->cfg);
550 if ((0 != (tc->reason & GNUNET_SCHEDULER_REASON_PREREQ_DONE)) ||
551 (GNUNET_NO == test_is_active))
556 cm->h->service_test_is_active = GNUNET_NO;
557 LOG (GNUNET_ERROR_TYPE_DEBUG,
558 "Looks like `%s' is not running, will start it.\n",
559 "gnunet-service-arm");
560 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (
561 cm->h->cfg, "arm", "PREFIX", &loprefix))
562 loprefix = GNUNET_strdup ("");
563 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (
564 cm->h->cfg, "arm", "OPTIONS", &lopostfix))
565 lopostfix = GNUNET_strdup ("");
566 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_string (
567 cm->h->cfg, "arm", "BINARY", &cbinary))
569 GNUNET_log_config_missing (GNUNET_ERROR_TYPE_WARNING, "arm", "BINARY");
571 cm->result_cont (cm->cont_cls, cm->h, GNUNET_ARM_REQUEST_SENT_OK, "arm", GNUNET_ARM_RESULT_IS_NOT_KNOWN);
573 GNUNET_free (loprefix);
574 GNUNET_free (lopostfix);
577 if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (
578 cm->h->cfg, "arm", "CONFIG", &config))
580 binary = GNUNET_OS_get_libexec_binary_path (cbinary);
581 GNUNET_free (cbinary);
582 if ((GNUNET_YES == GNUNET_CONFIGURATION_have_value (
583 cm->h->cfg, "TESTING", "WEAKRANDOM")) &&
584 (GNUNET_YES == GNUNET_CONFIGURATION_get_value_yesno (
585 cm->h->cfg, "TESTING", "WEAKRANDOM")) &&
586 (GNUNET_NO == GNUNET_CONFIGURATION_have_value (
587 cm->h->cfg, "TESTING", "HOSTFILE")))
589 /* Means we are ONLY running locally */
590 /* we're clearly running a test, don't daemonize */
592 proc = do_start_process (GNUNET_NO, cm->std_inheritance,
593 NULL, loprefix, binary,
594 /* no daemonization! */
597 proc = do_start_process (GNUNET_NO, cm->std_inheritance,
598 NULL, loprefix, binary, "-c", config,
599 /* no daemonization! */
605 proc = do_start_process (GNUNET_NO, cm->std_inheritance,
606 NULL, loprefix, binary,
607 "-d", lopostfix, NULL);
609 proc = do_start_process (GNUNET_NO, cm->std_inheritance,
610 NULL, loprefix, binary, "-c", config,
611 "-d", lopostfix, NULL);
613 GNUNET_free (binary);
614 GNUNET_free_non_null (config);
615 GNUNET_free (loprefix);
616 GNUNET_free (lopostfix);
620 cm->result_cont (cm->cont_cls, cm->h, GNUNET_ARM_REQUEST_SENT_OK, "arm",
621 GNUNET_ARM_RESULT_START_FAILED);
626 cm->result_cont (cm->cont_cls, cm->h, GNUNET_ARM_REQUEST_SENT_OK, "arm",
627 GNUNET_ARM_RESULT_STARTING);
628 GNUNET_OS_process_destroy (proc);
636 * Start or stop a service.
638 * @param h handle to ARM
639 * @param service_name name of the service
640 * @param timeout how long to wait before failing for good
641 * @param cb callback to invoke when service is ready
642 * @param cb_cls closure for callback
643 * @param type type of the request
646 change_service (struct GNUNET_ARM_Handle *h, const char *service_name,
647 struct GNUNET_TIME_Relative timeout, GNUNET_ARM_ResultCallback cb,
648 void *cb_cls, uint16_t type)
650 struct ARMControlMessage *cm;
652 struct GNUNET_ARM_Message *msg;
654 slen = strlen (service_name) + 1;
655 if (slen + sizeof (struct GNUNET_ARM_Message) >=
656 GNUNET_SERVER_MAX_MESSAGE_SIZE)
660 cb (cb_cls, h, GNUNET_ARM_REQUEST_TOO_LONG, NULL, 0);
663 LOG (GNUNET_ERROR_TYPE_DEBUG, "Requesting %s of service `%s'.\n",
664 (GNUNET_MESSAGE_TYPE_ARM_START == type) ? "start" : "termination",
666 cm = GNUNET_malloc (sizeof (struct ARMControlMessage) + slen);
668 cm->result_cont = cb;
669 cm->cont_cls = cb_cls;
670 cm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
671 memcpy (&cm[1], service_name, slen);
672 msg = GNUNET_malloc (sizeof (struct GNUNET_ARM_Message) + slen);
673 msg->header.size = htons (sizeof (struct GNUNET_ARM_Message) + slen);
674 msg->header.type = htons (type);
675 memcpy (&msg[1], service_name, slen);
677 LOG (GNUNET_ERROR_TYPE_DEBUG,
678 "Inserting a control message into the queue. Timeout is %llu\n",
679 GNUNET_TIME_absolute_get_remaining (cm->timeout).rel_value);
680 GNUNET_CONTAINER_DLL_insert_tail (h->control_pending_head,
681 h->control_pending_tail, cm);
682 cm->timeout_task_id =
683 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
684 (cm->timeout), &control_message_timeout, cm);
685 trigger_next_request (h, GNUNET_NO);
690 * Request for a service to be started.
692 * @param h handle to ARM
693 * @param service_name name of the service
694 * @param std_inheritance inheritance of std streams
695 * @param timeout how long to wait before failing for good
696 * @param cont callback to invoke after request is sent or not sent
697 * @param cont_cls closure for callback
700 GNUNET_ARM_request_service_start (struct GNUNET_ARM_Handle *h,
701 const char *service_name, enum GNUNET_OS_InheritStdioFlags std_inheritance,
702 struct GNUNET_TIME_Relative timeout, GNUNET_ARM_ResultCallback cont,
705 struct ARMControlMessage *cm;
708 LOG (GNUNET_ERROR_TYPE_DEBUG,
709 "Asked to start service `%s' within %s\n", service_name,
710 GNUNET_STRINGS_relative_time_to_string (timeout, GNUNET_NO));
711 if (0 == strcasecmp ("arm", service_name))
714 * 1) We're connected to ARM already. Invoke the callback immediately.
715 * 2) We're not connected to ARM.
716 * Cancel any reconnection attempts temporarily, then perform
719 if (GNUNET_NO == h->currently_down)
721 LOG (GNUNET_ERROR_TYPE_DEBUG, "ARM is already running\n");
723 cont (cont_cls, h, GNUNET_ARM_REQUEST_SENT_OK, "arm", GNUNET_ARM_RESULT_IS_STARTED_ALREADY);
725 else if (GNUNET_NO == h->service_test_is_active)
729 GNUNET_CLIENT_notify_transmit_ready_cancel (h->cth);
732 if (NULL != h->client)
734 GNUNET_CLIENT_disconnect (h->client);
737 if (GNUNET_SCHEDULER_NO_TASK != h->reconnect_task)
739 GNUNET_SCHEDULER_cancel (h->reconnect_task);
740 h->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
743 LOG (GNUNET_ERROR_TYPE_DEBUG,
744 "Not connected to ARM, will do a service test\n");
746 slen = strlen ("arm") + 1;
747 cm = GNUNET_malloc (sizeof (struct ARMControlMessage) + slen);
749 cm->result_cont = cont;
750 cm->cont_cls = cont_cls;
751 cm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
752 cm->std_inheritance = std_inheritance;
753 memcpy (&cm[1], service_name, slen);
754 h->service_test_is_active = GNUNET_YES;
755 GNUNET_CLIENT_service_test ("arm", h->cfg, timeout, &arm_service_report,
760 /* Service test is already running - tell user to chill out and try
763 LOG (GNUNET_ERROR_TYPE_DEBUG, "Service test is already in progress, we're busy\n");
765 cont (cont_cls, h, GNUNET_ARM_REQUEST_BUSY, NULL, 0);
769 change_service (h, service_name, timeout, cont, cont_cls,
770 GNUNET_MESSAGE_TYPE_ARM_START);
775 * Request a service to be stopped.
776 * Stopping arm itself will not invalidate its handle, and
777 * ARM API will try to restore connection to the ARM service,
778 * even if ARM connection was lost because you asked for ARM to be stopped.
779 * Call GNUNET_ARM_disconnect_and_free () to free the handle and prevent
780 * further connection attempts.
782 * @param h handle to ARM
783 * @param service_name name of the service
784 * @param timeout how long to wait before failing for good
785 * @param cont callback to invoke after request is sent or is not sent
786 * @param cont_cls closure for callback
789 GNUNET_ARM_request_service_stop (struct GNUNET_ARM_Handle *h,
790 const char *service_name, struct GNUNET_TIME_Relative timeout,
791 GNUNET_ARM_ResultCallback cont, void *cont_cls)
793 LOG (GNUNET_ERROR_TYPE_DEBUG,
794 "Stopping service `%s' within %s\n",
796 GNUNET_STRINGS_relative_time_to_string (timeout, GNUNET_NO));
797 change_service (h, service_name, timeout, cont, cont_cls,
798 GNUNET_MESSAGE_TYPE_ARM_STOP);
803 * Request a list of running services.
805 * @param h handle to ARM
806 * @param timeout how long to wait before failing for good
807 * @param cont callback to invoke after request is sent or is not sent
808 * @param cont_cls closure for callback
811 GNUNET_ARM_request_service_list (struct GNUNET_ARM_Handle *h,
812 struct GNUNET_TIME_Relative timeout,
813 GNUNET_ARM_ServiceListCallback cont,
816 struct ARMControlMessage *cm;
817 struct GNUNET_ARM_Message *msg;
819 LOG (GNUNET_ERROR_TYPE_DEBUG,
820 "Requesting LIST from ARM service with timeout: %s\n",
821 GNUNET_STRINGS_relative_time_to_string (timeout, GNUNET_YES));
822 cm = GNUNET_malloc (sizeof (struct ARMControlMessage));
824 cm->list_cont = cont;
825 cm->cont_cls = cont_cls;
826 cm->timeout = GNUNET_TIME_relative_to_absolute (timeout);
827 msg = GNUNET_malloc (sizeof (struct GNUNET_ARM_Message));
828 msg->header.size = htons (sizeof (struct GNUNET_ARM_Message));
829 msg->header.type = htons (GNUNET_MESSAGE_TYPE_ARM_LIST);
831 GNUNET_CONTAINER_DLL_insert_tail (h->control_pending_head,
832 h->control_pending_tail, cm);
833 cm->timeout_task_id =
834 GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_absolute_get_remaining
835 (cm->timeout), &control_message_timeout, cm);
836 trigger_next_request (h, GNUNET_NO);
840 static struct ARMControlMessage *
841 find_cm_by_id (struct GNUNET_ARM_Handle *h, uint64_t id)
843 struct ARMControlMessage *result;
844 for (result = h->control_sent_head; result; result = result->next)
845 if (id == result->msg->request_id)
852 * Handler for ARM replies.
854 * @param cls our "struct GNUNET_ARM_Handle"
855 * @param msg the message received from the arm service
858 client_notify_handler (void *cls, const struct GNUNET_MessageHeader *msg)
860 struct GNUNET_ARM_Handle *h = cls;
861 const struct GNUNET_ARM_Message *arm_msg;
862 const struct GNUNET_ARM_ResultMessage *res;
863 const struct GNUNET_ARM_ListResultMessage *lres;
864 struct ARMControlMessage *cm;
868 enum GNUNET_ARM_Result result;
877 LOG (GNUNET_ERROR_TYPE_INFO,
878 _("Client was disconnected from arm service, trying to reconnect.\n"));
879 reconnect_arm_later (h);
882 msize = ntohs (msg->size);
883 LOG (GNUNET_ERROR_TYPE_DEBUG,
884 "Processing message of type %u and size %u from arm service\n",
885 ntohs (msg->type), msize);
886 if (msize < sizeof (struct GNUNET_ARM_Message))
889 reconnect_arm_later (h);
892 arm_msg = (const struct GNUNET_ARM_Message *) msg;
893 id = GNUNET_ntohll (arm_msg->request_id);
894 cm = find_cm_by_id (h, id);
897 LOG (GNUNET_ERROR_TYPE_DEBUG, "Message with unknown id %llu\n", id);
901 switch (ntohs (msg->type))
903 case GNUNET_MESSAGE_TYPE_ARM_RESULT:
904 if (msize < sizeof (struct GNUNET_ARM_ResultMessage))
910 case GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT:
911 if (msize < sizeof (struct GNUNET_ARM_ListResultMessage))
918 lres = (const struct GNUNET_ARM_ListResultMessage *) msg;
919 rcount = ntohs (lres->count);
923 list = GNUNET_malloc (sizeof (const char *) * rcount);
924 pos = (const char *)&lres[1];
925 for (i = 0; i < rcount; i++)
927 const char *end = memchr (pos, 0, msize - size_check);
935 size_check += (end - pos) + 1;
938 if (GNUNET_YES == fail)
949 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK != cm->timeout_task_id);
950 GNUNET_SCHEDULER_cancel (cm->timeout_task_id);
951 GNUNET_CONTAINER_DLL_remove (h->control_sent_head,
952 h->control_sent_tail, cm);
953 if (GNUNET_YES == fail)
955 reconnect_arm_later (h);
956 GNUNET_free (cm->msg);
960 GNUNET_CLIENT_receive (h->client, &client_notify_handler, h,
961 GNUNET_TIME_UNIT_FOREVER_REL);
962 switch (ntohs (msg->type))
964 case GNUNET_MESSAGE_TYPE_ARM_RESULT:
965 res = (const struct GNUNET_ARM_ResultMessage *) msg;
966 LOG (GNUNET_ERROR_TYPE_DEBUG,
967 "Received response from ARM for service `%s': %u\n",
968 (const char *) &cm->msg[1], ntohs (msg->type));
969 result = (enum GNUNET_ARM_Result) ntohl (res->result);
970 if (NULL != cm->result_cont)
971 cm->result_cont (cm->cont_cls, h, GNUNET_ARM_REQUEST_SENT_OK,
972 (const char *) &cm->msg[1], result);
974 case GNUNET_MESSAGE_TYPE_ARM_LIST_RESULT:
975 if (NULL != cm->list_cont)
976 cm->list_cont (cm->cont_cls, h, GNUNET_ARM_REQUEST_SENT_OK, rcount,
981 GNUNET_free (cm->msg);
985 /* end of arm_api.c */