/*
This file is part of GNUnet
- (C) 2009 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009, 2016 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_arm_service.h
- * @brief API to access gnunet-arm
* @author Christian Grothoff
+ *
+ * @file
+ * API to access gnunet-arm
+ *
+ * @defgroup arm ARM service
+ * Automatic Restart Manager
+ *
+ * @see [Documentation](https://gnunet.org/arm)
+ *
+ * @{
*/
#ifndef GNUNET_ARM_SERVICE_H
#endif
#endif
-#include "gnunet_configuration_lib.h"
-#include "gnunet_scheduler_lib.h"
-#include "gnunet_time_lib.h"
+#include "gnunet_util_lib.h"
/**
* Version of the arm API.
*/
-#define GNUNET_ARM_VERSION 0x00000001
+#define GNUNET_ARM_VERSION 0x00000003
/**
- * Values characterizing GNUnet process states.
+ * Statuses of the requests that client can send to ARM.
*/
-enum GNUNET_ARM_ProcessStatus
+enum GNUNET_ARM_RequestStatus
{
/**
- * Service name is unknown to ARM.
+ * Message was sent successfully.
*/
- GNUNET_ARM_PROCESS_UNKNOWN = -1,
+ GNUNET_ARM_REQUEST_SENT_OK = 0,
/**
- * Service is now down (due to client request).
+ * We disconnected from ARM, and request was not sent.
*/
- GNUNET_ARM_PROCESS_DOWN = 0,
+ GNUNET_ARM_REQUEST_DISCONNECTED = 2
+
+};
+
+/**
+ * Statuses of services.
+ */
+enum GNUNET_ARM_ServiceStatus
+{
/**
- * Service is already running.
+ * Dummy message.
*/
- GNUNET_ARM_PROCESS_ALREADY_RUNNING = 1,
+ GNUNET_ARM_SERVICE_MONITORING_STARTED = 0,
/**
- * Service is currently being started (due to client request).
+ * Service was stopped.
*/
- GNUNET_ARM_PROCESS_STARTING = 2,
-
+ GNUNET_ARM_SERVICE_STOPPED = 1,
+
/**
- * Service is already being stopped by some other client.
+ * Service starting was initiated
*/
- GNUNET_ARM_PROCESS_ALREADY_STOPPING = 3,
+ GNUNET_ARM_SERVICE_STARTING = 2,
/**
- * Service is already down (no action taken)
+ * Service stopping was initiated
*/
- GNUNET_ARM_PROCESS_ALREADY_DOWN = 4,
+ GNUNET_ARM_SERVICE_STOPPING = 3
+};
+
+/**
+ * Replies to ARM requests
+ */
+enum GNUNET_ARM_Result
+{
/**
- * ARM is currently being shut down (no more process starts)
+ * Service was stopped (never sent for ARM itself).
*/
- GNUNET_ARM_PROCESS_SHUTDOWN = 5,
+ GNUNET_ARM_RESULT_STOPPED = 0,
/**
- * Error in communication with ARM
+ * ARM stopping was initiated (there's no "stopped" for ARM itself).
*/
- GNUNET_ARM_PROCESS_COMMUNICATION_ERROR = 6,
+ GNUNET_ARM_RESULT_STOPPING = 1,
/**
- * Timeout in communication with ARM
+ * Service starting was initiated
*/
- GNUNET_ARM_PROCESS_COMMUNICATION_TIMEOUT = 7,
+ GNUNET_ARM_RESULT_STARTING = 2,
/**
- * Failure to perform operation
+ * Asked to start it, but it's already starting.
*/
- GNUNET_ARM_PROCESS_FAILURE = 8
+ GNUNET_ARM_RESULT_IS_STARTING_ALREADY = 3,
+
+ /**
+ * Asked to stop it, but it's already stopping.
+ */
+ GNUNET_ARM_RESULT_IS_STOPPING_ALREADY = 4,
+
+ /**
+ * Asked to start it, but it's already started.
+ */
+ GNUNET_ARM_RESULT_IS_STARTED_ALREADY = 5,
+
+ /**
+ * Asked to stop it, but it's already stopped.
+ */
+ GNUNET_ARM_RESULT_IS_STOPPED_ALREADY = 6,
+
+ /**
+ * Asked to start or stop a service, but it's not known.
+ */
+ GNUNET_ARM_RESULT_IS_NOT_KNOWN = 7,
+
+ /**
+ * Tried to start a service, but that failed for some reason.
+ */
+ GNUNET_ARM_RESULT_START_FAILED = 8,
+
+ /**
+ * Asked to start something, but ARM is shutting down and can't comply.
+ */
+ GNUNET_ARM_RESULT_IN_SHUTDOWN = 9
};
/**
- * Callback function invoked when operation is complete.
+ * Handle for interacting with ARM.
+ */
+struct GNUNET_ARM_Handle;
+
+/**
+ * Handle for an ARM operation.
+ */
+struct GNUNET_ARM_Operation;
+
+
+/**
+ * Function called whenever we connect to or disconnect from ARM.
*
* @param cls closure
- * @param result outcome of the operation
+ * @param connected #GNUNET_YES if connected, #GNUNET_NO if disconnected,
+ * #GNUNET_SYSERR if there was an error.
*/
-typedef void (*GNUNET_ARM_Callback) (void *cls,
- enum GNUNET_ARM_ProcessStatus result);
+typedef void
+(*GNUNET_ARM_ConnectionStatusCallback) (void *cls,
+ int connected);
+
/**
- * Callback function invoked when list operation is complete.
+ * Function called in response to a start/stop request.
+ * Will be called when request was not sent successfully,
+ * or when a reply comes. If the request was not sent successfully,
+ * @a rs will indicate that, and @a result will be undefined.
*
* @param cls closure
- * @param result outcome of the operation (GNUNET_YES if successful)
- * @param count number of strings in the list
- * @param list list of running services
+ * @param rs status of the request
+ * @param result result of the operation
*/
-typedef void (*GNUNET_ARM_List_Callback) (void *cls,
- int result,
- uint16_t count,
- const char **list);
+typedef void
+(*GNUNET_ARM_ResultCallback) (void *cls,
+ enum GNUNET_ARM_RequestStatus rs,
+ enum GNUNET_ARM_Result result);
/**
- * Handle for interacting with ARM.
+ * Callback function invoked when list operation is complete.
+ * Will be called when request was not sent successfully,
+ * or when a reply comes. If the request was not sent successfully,
+ * @a rs will indicate that, and @a count and @a list will be undefined.
+ *
+ * @param cls closure
+ * @param rs status of the request
+ * @param count number of strings in the list
+ * @param list list of running services
*/
-struct GNUNET_ARM_Handle;
+typedef void
+(*GNUNET_ARM_ServiceListCallback) (void *cls,
+ enum GNUNET_ARM_RequestStatus rs,
+ unsigned int count,
+ const char *const*list);
/**
- * Setup a context for communicating with ARM. Note that this
- * can be done even if the ARM service is not yet running.
+ * Set up a context for communicating with ARM, then
+ * start connecting to the ARM service using that context.
*
* @param cfg configuration to use (needed to contact ARM;
* the ARM service may internally use a different
* configuration to determine how to start the service).
- * @param service service that *this* process is implementing/providing, can be NULL
- * @return context to use for further ARM operations, NULL on error
+ * @param conn_status will be called when connecting/disconnecting
+ * @param conn_status_cls closure for @a conn_status
+ * @return context to use for further ARM operations, NULL on error.
*/
struct GNUNET_ARM_Handle *
GNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const char *service);
+ GNUNET_ARM_ConnectionStatusCallback conn_status,
+ void *conn_status_cls);
/**
- * Disconnect from the ARM service.
+ * Disconnect from the ARM service and destroy the handle.
*
* @param h the handle that was being used
*/
/**
- * Start a service. Note that this function merely asks ARM to start
- * the service and that ARM merely confirms that it forked the
- * respective process. The specified callback may thus return before
- * the service has started to listen on the server socket and it may
- * also be that the service has crashed in the meantime. Clients
- * should repeatedly try to connect to the service at the respective
- * port (with some delays in between) before assuming that the service
- * actually failed to start. Note that if an error is returned to the
- * callback, clients obviously should not bother with trying to
- * contact the service.
+ * Abort an operation. Only prevents the callback from being
+ * called, the operation may still complete.
*
- * @param h handle to ARM
- * @param service_name name of the service
- * @param timeout how long to wait before failing for good
- * @param cb callback to invoke when service is ready
- * @param cb_cls closure for callback
+ * @param op operation to cancel
*/
void
-GNUNET_ARM_start_service (struct GNUNET_ARM_Handle *h, const char *service_name,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_ARM_Callback cb, void *cb_cls);
+GNUNET_ARM_operation_cancel (struct GNUNET_ARM_Operation *op);
/**
- * Stop a service. Note that the callback is invoked as soon
- * as ARM confirms that it will ask the service to terminate.
- * The actual termination may still take some time.
+ * Request a list of running services.
+ *
+ * @param h handle to ARM
+ * @param cont callback to invoke after request is sent or is not sent
+ * @param cont_cls closure for @a cont
+ * @return handle for the operation, NULL on error
+ */
+struct GNUNET_ARM_Operation *
+GNUNET_ARM_request_service_list (struct GNUNET_ARM_Handle *h,
+ GNUNET_ARM_ServiceListCallback cont,
+ void *cont_cls);
+
+
+/**
+ * Request a service to be stopped.
+ * Stopping arm itself will not invalidate its handle, and
+ * ARM API will try to restore connection to the ARM service,
+ * even if ARM connection was lost because you asked for ARM to be stopped.
+ * Call #GNUNET_ARM_disconnect() to free the handle and prevent
+ * further connection attempts.
*
* @param h handle to ARM
* @param service_name name of the service
- * @param timeout how long to wait before failing for good
- * @param cb callback to invoke when service is ready
- * @param cb_cls closure for callback
+ * @param cont callback to invoke after request is sent or is not sent
+ * @param cont_cls closure for @a cont
+ * @return handle for the operation, NULL on error
*/
-void
-GNUNET_ARM_stop_service (struct GNUNET_ARM_Handle *h, const char *service_name,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_ARM_Callback cb, void *cb_cls);
+struct GNUNET_ARM_Operation *
+GNUNET_ARM_request_service_stop (struct GNUNET_ARM_Handle *h,
+ const char *service_name,
+ GNUNET_ARM_ResultCallback cont,
+ void *cont_cls);
/**
- * List all running services.
- *
+ * Request for a service to be started.
+ *
* @param h handle to ARM
- * @param timeout how long to wait before failing for good
- * @param cb callback to invoke when service is ready
- * @param cb_cls closure for callback
+ * @param service_name name of the service
+ * @param std_inheritance inheritance of std streams
+ * @param cont callback to invoke after request is sent or not sent
+ * @param cont_cls closure for @a cont
+ * @return handle for the operation, NULL on error
+ */
+struct GNUNET_ARM_Operation *
+GNUNET_ARM_request_service_start (struct GNUNET_ARM_Handle *h,
+ const char *service_name,
+ enum GNUNET_OS_InheritStdioFlags std_inheritance,
+ GNUNET_ARM_ResultCallback cont,
+ void *cont_cls);
+
+
+/**
+ * Handle for monitoring ARM.
+ */
+struct GNUNET_ARM_MonitorHandle;
+
+
+/**
+ * Function called in when a status update arrives.
+ *
+ * @param cls closure
+ * @param service service name
+ * @param status status of the service
+ */
+typedef void
+(*GNUNET_ARM_ServiceStatusCallback) (void *cls,
+ const char *service,
+ enum GNUNET_ARM_ServiceStatus status);
+
+
+/**
+ * Setup a context for monitoring ARM, then
+ * start connecting to the ARM service for monitoring using that context.
+ *
+ * @param cfg configuration to use (needed to contact ARM;
+ * the ARM service may internally use a different
+ * configuration to determine how to start the service).
+ * @param cont callback to invoke on status updates
+ * @param cont_cls closure for @a cont
+ * @return context to use for further ARM monitor operations, NULL on error.
+ */
+struct GNUNET_ARM_MonitorHandle *
+GNUNET_ARM_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ GNUNET_ARM_ServiceStatusCallback cont,
+ void *cont_cls);
+
+
+/**
+ * Disconnect from the ARM service and destroy the handle.
+ *
+ * @param h the handle that was being used
*/
void
-GNUNET_ARM_list_running_services (struct GNUNET_ARM_Handle *h,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_ARM_List_Callback cb, void *cb_cls);
+GNUNET_ARM_monitor_stop (struct GNUNET_ARM_MonitorHandle *h);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#endif
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff