src/include/gnunet_arm_service.h

   1 /*
   2       This file is part of GNUnet
   3       (C) 2009 Christian Grothoff (and other contributing authors)
   4
   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.
   9
  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.
  14
  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.
  19  */
  20
  21 /**
  22  * @file include/gnunet_arm_service.h
  23  * @brief API to access gnunet-arm
  24  * @author Christian Grothoff
  25  */
  26
  27 #ifndef GNUNET_ARM_SERVICE_H
  28 #define GNUNET_ARM_SERVICE_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 #include "gnunet_configuration_lib.h"
  39 #include "gnunet_scheduler_lib.h"
  40 #include "gnunet_time_lib.h"
  41
  42 /**
  43  * Version of the arm API.
  44  */
  45 #define GNUNET_ARM_VERSION 0x00000001
  46
  47
  48 /**
  49  * Values characterizing GNUnet process states.
  50  */
  51 enum GNUNET_ARM_ProcessStatus
  52 {
  53   /**
  54    * Service name is unknown to ARM.
  55    */
  56   GNUNET_ARM_PROCESS_UNKNOWN = -1,
  57
  58   /**
  59    * Service is now down (due to client request).
  60    */
  61   GNUNET_ARM_PROCESS_DOWN = 0,
  62
  63   /**
  64    * Service is already running.
  65    */
  66   GNUNET_ARM_PROCESS_ALREADY_RUNNING = 1,
  67
  68   /**
  69    * Service is currently being started (due to client request).
  70    */
  71   GNUNET_ARM_PROCESS_STARTING = 2,
  72
  73   /**
  74    * Service is already being stopped by some other client.
  75    */
  76   GNUNET_ARM_PROCESS_ALREADY_STOPPING = 3,
  77
  78   /**
  79    * Service is already down (no action taken)
  80    */
  81   GNUNET_ARM_PROCESS_ALREADY_DOWN = 4,
  82
  83   /**
  84    * ARM is currently being shut down (no more process starts)
  85    */
  86   GNUNET_ARM_PROCESS_SHUTDOWN = 5,
  87
  88   /**
  89    * Error in communication with ARM
  90    */
  91   GNUNET_ARM_PROCESS_COMMUNICATION_ERROR = 6,
  92
  93   /**
  94    * Timeout in communication with ARM
  95    */
  96   GNUNET_ARM_PROCESS_COMMUNICATION_TIMEOUT = 7,
  97
  98   /**
  99    * Failure to perform operation
 100    */
 101   GNUNET_ARM_PROCESS_FAILURE = 8
 102 };
 103
 104
 105 /**
 106  * Callback function invoked when operation is complete.
 107  *
 108  * @param cls closure
 109  * @param result outcome of the operation
 110  */
 111 typedef void (*GNUNET_ARM_Callback) (void *cls,
 112                                      enum GNUNET_ARM_ProcessStatus result);
 113
 114
 115 /**
 116  * Handle for interacting with ARM.
 117  */
 118 struct GNUNET_ARM_Handle;
 119
 120
 121 /**
 122  * Setup a context for communicating with ARM.  Note that this
 123  * can be done even if the ARM service is not yet running.
 124  *
 125  * @param cfg configuration to use (needed to contact ARM;
 126  *        the ARM service may internally use a different
 127  *        configuration to determine how to start the service).
 128  * @param service service that *this* process is implementing/providing, can be NULL
 129  * @return context to use for further ARM operations, NULL on error
 130  */
 131 struct GNUNET_ARM_Handle *
 132 GNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 133                     const char *service);
 134
 135
 136 /**
 137  * Disconnect from the ARM service.
 138  *
 139  * @param h the handle that was being used
 140  */
 141 void
 142 GNUNET_ARM_disconnect (struct GNUNET_ARM_Handle *h);
 143
 144
 145 /**
 146  * Start a service.  Note that this function merely asks ARM to start
 147  * the service and that ARM merely confirms that it forked the
 148  * respective process.  The specified callback may thus return before
 149  * the service has started to listen on the server socket and it may
 150  * also be that the service has crashed in the meantime.  Clients
 151  * should repeatedly try to connect to the service at the respective
 152  * port (with some delays in between) before assuming that the service
 153  * actually failed to start.  Note that if an error is returned to the
 154  * callback, clients obviously should not bother with trying to
 155  * contact the service.
 156  *
 157  * @param h handle to ARM
 158  * @param service_name name of the service
 159  * @param timeout how long to wait before failing for good
 160  * @param cb callback to invoke when service is ready
 161  * @param cb_cls closure for callback
 162  */
 163 void
 164 GNUNET_ARM_start_service (struct GNUNET_ARM_Handle *h, const char *service_name,
 165                           struct GNUNET_TIME_Relative timeout,
 166                           GNUNET_ARM_Callback cb, void *cb_cls);
 167
 168
 169 /**
 170  * Stop a service.  Note that the callback is invoked as soon
 171  * as ARM confirms that it will ask the service to terminate.
 172  * The actual termination may still take some time.
 173  *
 174  * @param h handle to ARM
 175  * @param service_name name of the service
 176  * @param timeout how long to wait before failing for good
 177  * @param cb callback to invoke when service is ready
 178  * @param cb_cls closure for callback
 179  */
 180 void
 181 GNUNET_ARM_stop_service (struct GNUNET_ARM_Handle *h, const char *service_name,
 182                          struct GNUNET_TIME_Relative timeout,
 183                          GNUNET_ARM_Callback cb, void *cb_cls);
 184
 185
 186
 187 #if 0                           /* keep Emacsens' auto-indent happy */
 188 {
 189 #endif
 190 #ifdef __cplusplus
 191 }
 192 #endif
 193
 194 #endif