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_os_lib.h"
  41 #include "gnunet_time_lib.h"
  42
  43 /**
  44  * Version of the arm API.
  45  */
  46 #define GNUNET_ARM_VERSION 0x00000002
  47
  48
  49 /**
  50  * Statuses of the requests that client can send to ARM.
  51  */
  52 enum GNUNET_ARM_RequestStatus
  53 {
  54   /**
  55    * Message was sent successfully.
  56    */
  57   GNUNET_ARM_REQUEST_SENT_OK = 0,
  58
  59   /**
  60    * Misconfiguration (can't connect to the ARM service).
  61    */
  62   GNUNET_ARM_REQUEST_CONFIGURATION_ERROR = 1,
  63
  64   /**
  65    * We disconnected from ARM, and request was not sent.
  66    */
  67   GNUNET_ARM_REQUEST_DISCONNECTED = 2,
  68
  69   /**
  70    * ARM API is busy (probably trying to connect to ARM),
  71    * and request was not sent. Try again later.
  72    */
  73   GNUNET_ARM_REQUEST_BUSY = 3,
  74
  75   /**
  76    * It was discovered that the request would be too long to fit in a message,
  77    * and thus it was not sent.
  78    */
  79   GNUNET_ARM_REQUEST_TOO_LONG = 4,
  80
  81   /**
  82    * Request time ran out before we had a chance to send it.
  83    */
  84   GNUNET_ARM_REQUEST_TIMEOUT = 5
  85
  86 };
  87
  88
  89 /**
  90  * Statuses of services.
  91  */
  92 enum GNUNET_ARM_ServiceStatus
  93 {
  94   /**
  95    * Dummy message.
  96    */
  97   GNUNET_ARM_SERVICE_MONITORING_STARTED = 0,
  98
  99   /**
 100    * Service was stopped.
 101    */
 102   GNUNET_ARM_SERVICE_STOPPED = 1,
 103
 104   /**
 105    * Service starting was initiated
 106    */
 107   GNUNET_ARM_SERVICE_STARTING = 2,
 108
 109   /**
 110    * Service stopping was initiated
 111    */
 112   GNUNET_ARM_SERVICE_STOPPING = 3
 113 };
 114
 115
 116 /**
 117  * Replies to ARM requests
 118  */
 119 enum GNUNET_ARM_Result
 120 {
 121   /**
 122    * Service was stopped (never sent for ARM itself).
 123    */
 124   GNUNET_ARM_RESULT_STOPPED = 0,
 125
 126   /**
 127    * ARM stopping was initiated (there's no "stopped" for ARM itself).
 128    */
 129   GNUNET_ARM_RESULT_STOPPING = 1,
 130
 131   /**
 132    * Service starting was initiated
 133    */
 134   GNUNET_ARM_RESULT_STARTING = 2,
 135
 136   /**
 137    * Asked to start it, but it's already starting.
 138    */
 139   GNUNET_ARM_RESULT_IS_STARTING_ALREADY = 3,
 140
 141   /**
 142    * Asked to stop it, but it's already stopping.
 143    */
 144   GNUNET_ARM_RESULT_IS_STOPPING_ALREADY = 4,
 145
 146   /**
 147    * Asked to start it, but it's already started.
 148    */
 149   GNUNET_ARM_RESULT_IS_STARTED_ALREADY = 5,
 150
 151   /**
 152    * Asked to stop it, but it's already stopped.
 153    */
 154   GNUNET_ARM_RESULT_IS_STOPPED_ALREADY = 6,
 155
 156   /**
 157    * Asked to start or stop a service, but it's not known.
 158    */
 159   GNUNET_ARM_RESULT_IS_NOT_KNOWN = 7,
 160
 161   /**
 162    * Tried to start a service, but that failed for some reason.
 163    */
 164   GNUNET_ARM_RESULT_START_FAILED = 8,
 165
 166   /**
 167    * Asked to start something, but ARM is shutting down and can't comply.
 168    */
 169   GNUNET_ARM_RESULT_IN_SHUTDOWN = 9
 170 };
 171
 172
 173 /**
 174  * Handle for interacting with ARM.
 175  */
 176 struct GNUNET_ARM_Handle;
 177
 178
 179 /**
 180  * Function called whenever we connect to or disconnect from ARM.
 181  *
 182  * @param cls closure
 183  * @param connected GNUNET_YES if connected, GNUNET_NO if disconnected,
 184  *                  GNUNET_SYSERR if there was an error.
 185  */
 186 typedef void (*GNUNET_ARM_ConnectionStatusCallback) (void *cls,
 187                                                      int connected);
 188
 189
 190 /**
 191  * Function called in response to a start/stop request.
 192  * Will be called when request was not sent successfully,
 193  * or when a reply comes. If the request was not sent successfully,
 194  * 'rs' will indicate that, and 'service' and 'result' will be undefined.
 195  *
 196  * @param cls closure
 197  * @param rs status of the request
 198  * @param service service name
 199  * @param result result of the operation
 200  */
 201 typedef void (*GNUNET_ARM_ResultCallback) (void *cls,
 202                                            enum GNUNET_ARM_RequestStatus rs,
 203                                            const char *service,
 204                                            enum GNUNET_ARM_Result result);
 205
 206
 207 /**
 208  * Callback function invoked when list operation is complete.
 209  * Will be called when request was not sent successfully,
 210  * or when a reply comes. If the request was not sent successfully,
 211  * 'rs' will indicate that, and 'count' and 'list' will be undefined.
 212  *
 213  * @param cls closure
 214  * @param rs status of the request
 215  * @param count number of strings in the list
 216  * @param list list of running services
 217  */
 218 typedef void (*GNUNET_ARM_ServiceListCallback) (void *cls,
 219                                                 enum GNUNET_ARM_RequestStatus rs,
 220                                                 unsigned int count,
 221                                                 const char *const*list);
 222
 223
 224 /**
 225  * Set up a context for communicating with ARM, then
 226  * start connecting to the ARM service using that context.
 227  *
 228  * @param cfg configuration to use (needed to contact ARM;
 229  *        the ARM service may internally use a different
 230  *        configuration to determine how to start the service).
 231  * @param conn_status will be called when connecting/disconnecting
 232  * @param cls closure for conn_status
 233  * @return context to use for further ARM operations, NULL on error.
 234  */
 235 struct GNUNET_ARM_Handle *
 236 GNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 237                     GNUNET_ARM_ConnectionStatusCallback conn_status,
 238                     void *cls);
 239
 240
 241 /**
 242  * Disconnect from the ARM service and destroy the handle.
 243  *
 244  * @param h the handle that was being used
 245  */
 246 void
 247 GNUNET_ARM_disconnect_and_free (struct GNUNET_ARM_Handle *h);
 248
 249
 250 /**
 251  * Request a list of running services.
 252  *
 253  * @param h handle to ARM
 254  * @param timeout how long to wait before failing for good
 255  * @param cont callback to invoke after request is sent or is not sent
 256  * @param cont_cls closure for callback
 257  */
 258 void
 259 GNUNET_ARM_request_service_list (struct GNUNET_ARM_Handle *h,
 260                                  struct GNUNET_TIME_Relative timeout,
 261                                  GNUNET_ARM_ServiceListCallback cont, void *cont_cls);
 262
 263
 264 /**
 265  * Request a service to be stopped.
 266  * Stopping arm itself will not invalidate its handle, and
 267  * ARM API will try to restore connection to the ARM service,
 268  * even if ARM connection was lost because you asked for ARM to be stopped.
 269  * Call GNUNET_ARM_disconnect_and_free () to free the handle and prevent
 270  * further connection attempts.
 271  *
 272  * @param h handle to ARM
 273  * @param service_name name of the service
 274  * @param timeout how long to wait before failing for good
 275  * @param cont callback to invoke after request is sent or is not sent
 276  * @param cont_cls closure for callback
 277  */
 278 void
 279 GNUNET_ARM_request_service_stop (struct GNUNET_ARM_Handle *h,
 280                                  const char *service_name,
 281                                  struct GNUNET_TIME_Relative timeout,
 282                                  GNUNET_ARM_ResultCallback cont, void *cont_cls);
 283
 284
 285 /**
 286  * Request for a service to be started.
 287  *
 288  * @param h handle to ARM
 289  * @param service_name name of the service
 290  * @param std_inheritance inheritance of std streams
 291  * @param timeout how long to wait before failing for good
 292  * @param cont callback to invoke after request is sent or not sent
 293  * @param cont_cls closure for callback
 294  */
 295 void
 296 GNUNET_ARM_request_service_start (struct GNUNET_ARM_Handle *h,
 297                                   const char *service_name,
 298                                   enum GNUNET_OS_InheritStdioFlags std_inheritance,
 299                                   struct GNUNET_TIME_Relative timeout,
 300                                   GNUNET_ARM_ResultCallback cont,
 301                                   void *cont_cls);
 302
 303
 304 /**
 305  * Handle for monitoring ARM.
 306  */
 307 struct GNUNET_ARM_MonitorHandle;
 308
 309
 310 /**
 311  * Function called in when a status update arrives.
 312  *
 313  * @param cls closure
 314  * @param arm handle to the arm connection
 315  * @param service service name
 316  * @param status status of the service
 317  */
 318 typedef void (*GNUNET_ARM_ServiceStatusCallback) (void *cls,
 319                                                   const char *service,
 320                                                   enum GNUNET_ARM_ServiceStatus status);
 321
 322
 323 /**
 324  * Setup a context for monitoring ARM, then
 325  * start connecting to the ARM service for monitoring using that context.
 326  *
 327  * @param cfg configuration to use (needed to contact ARM;
 328  *        the ARM service may internally use a different
 329  *        configuration to determine how to start the service).
 330  * @param cont callback to invoke on status updates
 331  * @param cont_cls closure
 332  * @return context to use for further ARM monitor operations, NULL on error.
 333  */
 334 struct GNUNET_ARM_MonitorHandle *
 335 GNUNET_ARM_monitor (const struct GNUNET_CONFIGURATION_Handle *cfg,
 336                     GNUNET_ARM_ServiceStatusCallback cont,
 337                     void *cont_cls);
 338
 339
 340 /**
 341  * Disconnect from the ARM service and destroy the handle.
 342  *
 343  * @param h the handle that was being used
 344  */
 345 void
 346 GNUNET_ARM_monitor_disconnect_and_free (struct GNUNET_ARM_MonitorHandle *h);
 347
 348
 349 #if 0                           /* keep Emacsens' auto-indent happy */
 350 {
 351 #endif
 352 #ifdef __cplusplus
 353 }
 354 #endif
 355
 356 #endif