GNUnet 0.22.1
gnunet_arm_service.h File Reference
#include "gnunet_util_lib.h"
Include dependency graph for gnunet_arm_service.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  GNUNET_ARM_ServiceInfo
 Information about a service managed by ARM. More...
 

Macros

#define GNUNET_ARM_VERSION   0x00000003
 Version of the arm API. More...
 

Typedefs

typedef void(* GNUNET_ARM_ConnectionStatusCallback) (void *cls, enum GNUNET_GenericReturnValue connected)
 Function called whenever we connect to or disconnect from ARM. More...
 
typedef void(* GNUNET_ARM_ResultCallback) (void *cls, enum GNUNET_ARM_RequestStatus rs, enum GNUNET_ARM_Result result)
 Function called in response to a start/stop request. More...
 
typedef void(* GNUNET_ARM_ServiceListCallback) (void *cls, enum GNUNET_ARM_RequestStatus rs, unsigned int count, const struct GNUNET_ARM_ServiceInfo *list)
 Callback function invoked when list operation is complete. More...
 
typedef void(* GNUNET_ARM_ServiceMonitorCallback) (void *cls, const char *service, enum GNUNET_ARM_ServiceMonitorStatus status)
 Function called in when a status update arrives. More...
 

Enumerations

enum  GNUNET_ARM_RequestStatus { GNUNET_ARM_REQUEST_SENT_OK = 0 , GNUNET_ARM_REQUEST_DISCONNECTED = 2 }
 Statuses of the requests that client can send to ARM. More...
 
enum  GNUNET_ARM_ServiceMonitorStatus { GNUNET_ARM_SERVICE_MONITORING_STARTED = 0 , GNUNET_ARM_SERVICE_STOPPED = 1 , GNUNET_ARM_SERVICE_STARTING = 2 , GNUNET_ARM_SERVICE_STOPPING = 3 }
 Statuses of services. More...
 
enum  GNUNET_ARM_Result {
  GNUNET_ARM_RESULT_STOPPED = 0 , GNUNET_ARM_RESULT_STOPPING = 1 , GNUNET_ARM_RESULT_STARTING = 2 , GNUNET_ARM_RESULT_IS_STARTING_ALREADY = 3 ,
  GNUNET_ARM_RESULT_IS_STOPPING_ALREADY = 4 , GNUNET_ARM_RESULT_IS_STARTED_ALREADY = 5 , GNUNET_ARM_RESULT_IS_STOPPED_ALREADY = 6 , GNUNET_ARM_RESULT_IS_NOT_KNOWN = 7 ,
  GNUNET_ARM_RESULT_START_FAILED = 8 , GNUNET_ARM_RESULT_IN_SHUTDOWN = 9
}
 Replies to ARM requests. More...
 
enum  GNUNET_ARM_ServiceStatus {
  GNUNET_ARM_SERVICE_STATUS_STOPPED = 0 , GNUNET_ARM_SERVICE_STATUS_STARTED = 1 , GNUNET_ARM_SERVICE_STATUS_FAILED = 2 , GNUNET_ARM_SERVICE_STATUS_FINISHED = 3 ,
  GNUNET_ARM_SERVICE_STATUS_STOPPING = 4
}
 Status of a service managed by ARM. More...
 

Functions

struct GNUNET_ARM_HandleGNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_ARM_ConnectionStatusCallback conn_status, void *conn_status_cls)
 Set up a context for communicating with ARM, then start connecting to the ARM service using that context. More...
 
void GNUNET_ARM_disconnect (struct GNUNET_ARM_Handle *h)
 Disconnect from the ARM service and destroy the handle. More...
 
void GNUNET_ARM_operation_cancel (struct GNUNET_ARM_Operation *op)
 Abort an operation. More...
 
struct GNUNET_ARM_OperationGNUNET_ARM_request_service_list (struct GNUNET_ARM_Handle *h, GNUNET_ARM_ServiceListCallback cont, void *cont_cls)
 Request a list of running services. More...
 
struct GNUNET_ARM_OperationGNUNET_ARM_request_service_stop (struct GNUNET_ARM_Handle *h, const char *service_name, GNUNET_ARM_ResultCallback cont, void *cont_cls)
 Request a service to be stopped. More...
 
struct GNUNET_ARM_OperationGNUNET_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)
 Request for a service to be started. More...
 
struct GNUNET_ARM_MonitorHandleGNUNET_ARM_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_ARM_ServiceMonitorCallback cont, void *cont_cls)
 Setup a context for monitoring ARM, then start connecting to the ARM service for monitoring using that context. More...
 
void GNUNET_ARM_monitor_stop (struct GNUNET_ARM_MonitorHandle *h)
 Disconnect from the ARM service and destroy the handle. More...
 

Detailed Description

Author
Christian Grothoff

API to access gnunet-arm

Definition in file gnunet_arm_service.h.