2 This file is part of GNUnet
3 (C) 2009 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.
22 * @file include/gnunet_arm_service.h
23 * @brief API to access gnunet-arm
24 * @author Christian Grothoff
27 #ifndef GNUNET_ARM_SERVICE_H
28 #define GNUNET_ARM_SERVICE_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_configuration_lib.h"
39 #include "gnunet_scheduler_lib.h"
40 #include "gnunet_os_lib.h"
41 #include "gnunet_time_lib.h"
44 * Version of the arm API.
46 #define GNUNET_ARM_VERSION 0x00000002
50 * Statuses of the requests that client can send to ARM.
52 enum GNUNET_ARM_RequestStatus
55 * Message was sent successfully.
57 GNUNET_ARM_REQUEST_SENT_OK = 0,
60 * Misconfiguration (can't connect to the ARM service).
62 GNUNET_ARM_REQUEST_CONFIGURATION_ERROR = 1,
65 * We disconnected from ARM, and request was not sent.
67 GNUNET_ARM_REQUEST_DISCONNECTED = 2,
70 * ARM API is busy (probably trying to connect to ARM),
71 * and request was not sent. Try again later.
73 GNUNET_ARM_REQUEST_BUSY = 3,
76 * It was discovered that the request would be too long to fit in a message,
77 * and thus it was not sent.
79 GNUNET_ARM_REQUEST_TOO_LONG = 4,
82 * Request time ran out before we had a chance to send it.
84 GNUNET_ARM_REQUEST_TIMEOUT = 5
90 * Statuses of services.
92 enum GNUNET_ARM_ServiceStatus
97 GNUNET_ARM_SERVICE_MONITORING_STARTED = 0,
100 * Service was stopped.
102 GNUNET_ARM_SERVICE_STOPPED = 1,
105 * Service starting was initiated
107 GNUNET_ARM_SERVICE_STARTING = 2,
110 * Service stopping was initiated
112 GNUNET_ARM_SERVICE_STOPPING = 3
116 * Replies to ARM requests
118 enum GNUNET_ARM_Result
121 * Service was stopped (never sent for ARM itself).
123 GNUNET_ARM_RESULT_STOPPED = 0,
126 * ARM stopping was initiated (there's no "stopped" for ARM itself).
128 GNUNET_ARM_RESULT_STOPPING = 1,
131 * Service starting was initiated
133 GNUNET_ARM_RESULT_STARTING = 2,
136 * Asked to start it, but it's already starting.
138 GNUNET_ARM_RESULT_IS_STARTING_ALREADY = 3,
141 * Asked to stop it, but it's already stopping.
143 GNUNET_ARM_RESULT_IS_STOPPING_ALREADY = 4,
146 * Asked to start it, but it's already started.
148 GNUNET_ARM_RESULT_IS_STARTED_ALREADY = 5,
151 * Asked to stop it, but it's already stopped.
153 GNUNET_ARM_RESULT_IS_STOPPED_ALREADY = 6,
156 * Asked to start or stop a service, but it's not known.
158 GNUNET_ARM_RESULT_IS_NOT_KNOWN = 7,
161 * Tried to start a service, but that failed for some reason.
163 GNUNET_ARM_RESULT_START_FAILED = 8,
166 * Asked to start something, but ARM is shutting down and can't comply.
168 GNUNET_ARM_RESULT_IN_SHUTDOWN = 9
173 * Handle for interacting with ARM.
175 struct GNUNET_ARM_Handle;
179 * Function called whenever we connect to or disconnect from ARM.
182 * @param connected GNUNET_YES if connected, GNUNET_NO if disconnected,
183 * GNUNET_SYSERR if there was an error.
184 * @param error GNUNET_YES if we encountered a permanent error, and there
185 * will be no re-connection.
187 typedef void (*GNUNET_ARM_ConnectionStatusCallback) (void *cls,
188 struct GNUNET_ARM_Handle *arm,
193 * Function called in response to a start/stop request.
194 * Will be called when request was not sent successfully,
195 * or when a reply comes. If the request was not sent successfully,
196 * 'rs' will indicate that, and 'service' and 'result' will be undefined.
199 * @param arm handle to the arm connection
200 * @param rs status of the request
201 * @param service service name
202 * @param result result of the operation
204 typedef void (*GNUNET_ARM_ResultCallback) (void *cls, struct GNUNET_ARM_Handle *arm, enum GNUNET_ARM_RequestStatus rs, const char *service, enum GNUNET_ARM_Result result);
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.
214 * @param arm handle to the arm connection
215 * @param rs status of the request
216 * @param count number of strings in the list
217 * @param list list of running services
219 typedef void (*GNUNET_ARM_ServiceListCallback) (void *cls, struct GNUNET_ARM_Handle *arm, enum GNUNET_ARM_RequestStatus rs, unsigned int count, const char *const*list);
223 * Set up a context for communicating with ARM, then
224 * start connecting to the ARM service using that context.
226 * @param cfg configuration to use (needed to contact ARM;
227 * the ARM service may internally use a different
228 * configuration to determine how to start the service).
229 * @param conn_status will be called when connecting/disconnecting
230 * @param cls closure for conn_status
231 * @return context to use for further ARM operations, NULL on error.
233 struct GNUNET_ARM_Handle *
234 GNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
235 GNUNET_ARM_ConnectionStatusCallback conn_status, void *cls);
239 * Disconnect from the ARM service and destroy the handle.
240 * Don't call this from inside an ARM callback!
242 * @param h the handle that was being used
245 GNUNET_ARM_disconnect_and_free (struct GNUNET_ARM_Handle *h);
249 * Request a list of running services.
251 * @param h handle to ARM
252 * @param timeout how long to wait before failing for good
253 * @param cont callback to invoke after request is sent or is not sent
254 * @param cont_cls closure for callback
257 GNUNET_ARM_request_service_list (struct GNUNET_ARM_Handle *h,
258 struct GNUNET_TIME_Relative timeout,
259 GNUNET_ARM_ServiceListCallback cont, void *cont_cls);
263 * Request a service to be stopped.
264 * Stopping arm itself will not invalidate its handle, and
265 * ARM API will try to restore connection to the ARM service,
266 * even if ARM connection was lost because you asked for ARM to be stopped.
267 * Call GNUNET_ARM_disconnect_and_free () to free the handle and prevent
268 * further connection attempts.
270 * @param h handle to ARM
271 * @param service_name name of the service
272 * @param timeout how long to wait before failing for good
273 * @param cont callback to invoke after request is sent or is not sent
274 * @param cont_cls closure for callback
277 GNUNET_ARM_request_service_stop (struct GNUNET_ARM_Handle *h,
278 const char *service_name, struct GNUNET_TIME_Relative timeout,
279 GNUNET_ARM_ResultCallback cont, void *cont_cls);
283 * Request for a service to be started.
285 * @param h handle to ARM
286 * @param service_name name of the service
287 * @param std_inheritance inheritance of std streams
288 * @param timeout how long to wait before failing for good
289 * @param cont callback to invoke after request is sent or not sent
290 * @param cont_cls closure for callback
293 GNUNET_ARM_request_service_start (struct GNUNET_ARM_Handle *h,
294 const char *service_name, enum GNUNET_OS_InheritStdioFlags std_inheritance,
295 struct GNUNET_TIME_Relative timeout, GNUNET_ARM_ResultCallback cont,
300 * Handle for monitoring ARM.
302 struct GNUNET_ARM_MonitorHandle;
306 * Function called in when a status update arrives.
309 * @param arm handle to the arm connection
310 * @param service service name
311 * @param status status of the service
313 typedef void (*GNUNET_ARM_ServiceStatusCallback) (void *cls, struct GNUNET_ARM_MonitorHandle *arm, const char *service, enum GNUNET_ARM_ServiceStatus status);
317 * Setup a context for monitoring ARM, then
318 * start connecting to the ARM service for monitoring using that context.
320 * @param cfg configuration to use (needed to contact ARM;
321 * the ARM service may internally use a different
322 * configuration to determine how to start the service).
323 * @param cont callback to invoke on status updates
324 * @param cont_cls closure
325 * @return context to use for further ARM monitor operations, NULL on error.
327 struct GNUNET_ARM_MonitorHandle *
328 GNUNET_ARM_monitor (const struct GNUNET_CONFIGURATION_Handle *cfg,
329 GNUNET_ARM_ServiceStatusCallback cont, void *cont_cls);
333 * Disconnect from the ARM service and destroy the handle.
334 * Don't call this from inside an ARM callback!
336 * @param h the handle that was being used
339 GNUNET_ARM_monitor_disconnect_and_free (struct GNUNET_ARM_MonitorHandle *h);
342 #if 0 /* keep Emacsens' auto-indent happy */