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 0x00000000
  46
  47
  48 /**
  49  * Callback function invoked when operation is complete.
  50  *
  51  * @param cls closure
  52  * @param success GNUNET_YES if we think the service is running
  53  *                GNUNET_NO if we think the service is stopped
  54  *                GNUNET_SYSERR if we think ARM was not running or
  55  *                          if the service status is unknown
  56  */
  57 typedef void (*GNUNET_ARM_Callback) (void *cls, int success);
  58
  59
  60 /**
  61  * Handle for interacting with ARM.
  62  */
  63 struct GNUNET_ARM_Handle;
  64
  65
  66 /**
  67  * Setup a context for communicating with ARM.  Note that this
  68  * can be done even if the ARM service is not yet running.
  69  *
  70  * @param cfg configuration to use (needed to contact ARM;
  71  *        the ARM service may internally use a different
  72  *        configuration to determine how to start the service).
  73  * @param sched scheduler to use
  74  * @param service service that *this* process is implementing/providing, can be NULL
  75  * @return context to use for further ARM operations, NULL on error
  76  */
  77 struct GNUNET_ARM_Handle *
  78 GNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
  79                     struct GNUNET_SCHEDULER_Handle *sched,
  80                     const char *service);
  81
  82
  83 /**
  84  * Disconnect from the ARM service.
  85  *
  86  * @param h the handle that was being used
  87  */
  88 void
  89 GNUNET_ARM_disconnect (struct GNUNET_ARM_Handle *h);
  90
  91
  92 /**
  93  * Start a service.  Note that this function merely asks ARM to start
  94  * the service and that ARM merely confirms that it forked the
  95  * respective process.  The specified callback may thus return before
  96  * the service has started to listen on the server socket and it may
  97  * also be that the service has crashed in the meantime.  Clients
  98  * should repeatedly try to connect to the service at the respective
  99  * port (with some delays in between) before assuming that the service
 100  * actually failed to start.  Note that if an error is returned to the
 101  * callback, clients obviously should not bother with trying to
 102  * contact the service.
 103  *
 104  * @param h handle to ARM
 105  * @param service_name name of the service
 106  * @param timeout how long to wait before failing for good
 107  * @param cb callback to invoke when service is ready
 108  * @param cb_cls closure for callback
 109  */
 110 void
 111 GNUNET_ARM_start_service (struct GNUNET_ARM_Handle *h,
 112                           const char *service_name,
 113                           struct GNUNET_TIME_Relative timeout,
 114                           GNUNET_ARM_Callback cb, void *cb_cls);
 115
 116
 117 /**
 118  * Stop a service.  Note that the callback is invoked as soon
 119  * as ARM confirms that it will ask the service to terminate.
 120  * The actual termination may still take some time.
 121  *
 122  * @param h handle to ARM
 123  * @param service_name name of the service
 124  * @param timeout how long to wait before failing for good
 125  * @param cb callback to invoke when service is ready
 126  * @param cb_cls closure for callback
 127  */
 128 void
 129 GNUNET_ARM_stop_service (struct GNUNET_ARM_Handle *h,
 130                          const char *service_name,
 131                          struct GNUNET_TIME_Relative timeout,
 132                          GNUNET_ARM_Callback cb, void *cb_cls);
 133
 134
 135
 136 #if 0                           /* keep Emacsens' auto-indent happy */
 137 {
 138 #endif
 139 #ifdef __cplusplus
 140 }
 141 #endif
 142
 143 #endif