GNUnet  0.10.x
Macros | Typedefs | Enumerations | Functions
ARM service

Automatic Restart Manager. More...

Macros

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

Typedefs

typedef void(* GNUNET_ARM_ConnectionStatusCallback) (void *cls, int 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 char *const *list)
 Callback function invoked when list operation is complete. More...
 
typedef void(* GNUNET_ARM_ServiceStatusCallback) (void *cls, const char *service, enum GNUNET_ARM_ServiceStatus 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_ServiceStatus { 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...
 

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_ServiceStatusCallback 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

Automatic Restart Manager.

See also
Documentation

Macro Definition Documentation

◆ GNUNET_ARM_VERSION

#define GNUNET_ARM_VERSION   0x00000003

Version of the arm API.

Definition at line 51 of file gnunet_arm_service.h.

Typedef Documentation

◆ GNUNET_ARM_ConnectionStatusCallback

typedef void(* GNUNET_ARM_ConnectionStatusCallback) (void *cls, int connected)

Function called whenever we connect to or disconnect from ARM.

Parameters
clsclosure
connectedGNUNET_YES if connected, GNUNET_NO if disconnected, GNUNET_SYSERR if there was an error.

Definition at line 171 of file gnunet_arm_service.h.

◆ GNUNET_ARM_ResultCallback

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.

Will be called when request was not sent successfully, or when a reply comes. If the request was not sent successfully, rs will indicate that, and result will be undefined.

Parameters
clsclosure
rsstatus of the request
resultresult of the operation

Definition at line 186 of file gnunet_arm_service.h.

◆ GNUNET_ARM_ServiceListCallback

typedef void(* GNUNET_ARM_ServiceListCallback) (void *cls, enum GNUNET_ARM_RequestStatus rs, unsigned int count, const char *const *list)

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, rs will indicate that, and count and list will be undefined.

Parameters
clsclosure
rsstatus of the request
countnumber of strings in the list
listlist of running services

Definition at line 203 of file gnunet_arm_service.h.

◆ GNUNET_ARM_ServiceStatusCallback

typedef void(* GNUNET_ARM_ServiceStatusCallback) (void *cls, const char *service, enum GNUNET_ARM_ServiceStatus status)

Function called in when a status update arrives.

Parameters
clsclosure
serviceservice name
statusstatus of the service

Definition at line 312 of file gnunet_arm_service.h.

Enumeration Type Documentation

◆ GNUNET_ARM_RequestStatus

Statuses of the requests that client can send to ARM.

Enumerator
GNUNET_ARM_REQUEST_SENT_OK 

Message was sent successfully.

GNUNET_ARM_REQUEST_DISCONNECTED 

We disconnected from ARM, and request was not sent.

Definition at line 57 of file gnunet_arm_service.h.

57  {
62 
67 };
We disconnected from ARM, and request was not sent.
Message was sent successfully.

◆ GNUNET_ARM_ServiceStatus

Statuses of services.

Enumerator
GNUNET_ARM_SERVICE_MONITORING_STARTED 

Dummy message.

GNUNET_ARM_SERVICE_STOPPED 

Service was stopped.

GNUNET_ARM_SERVICE_STARTING 

Service starting was initiated.

GNUNET_ARM_SERVICE_STOPPING 

Service stopping was initiated.

Definition at line 73 of file gnunet_arm_service.h.

73  {
78 
83 
88 
93 };
Service starting was initiated.
Service was stopped.
Service stopping was initiated.

◆ GNUNET_ARM_Result

Replies to ARM requests.

Enumerator
GNUNET_ARM_RESULT_STOPPED 

Service was stopped (never sent for ARM itself).

GNUNET_ARM_RESULT_STOPPING 

ARM stopping was initiated (there's no "stopped" for ARM itself).

GNUNET_ARM_RESULT_STARTING 

Service starting was initiated.

GNUNET_ARM_RESULT_IS_STARTING_ALREADY 

Asked to start it, but it's already starting.

GNUNET_ARM_RESULT_IS_STOPPING_ALREADY 

Asked to stop it, but it's already stopping.

GNUNET_ARM_RESULT_IS_STARTED_ALREADY 

Asked to start it, but it's already started.

GNUNET_ARM_RESULT_IS_STOPPED_ALREADY 

Asked to stop it, but it's already stopped.

GNUNET_ARM_RESULT_IS_NOT_KNOWN 

Asked to start or stop a service, but it's not known.

GNUNET_ARM_RESULT_START_FAILED 

Tried to start a service, but that failed for some reason.

GNUNET_ARM_RESULT_IN_SHUTDOWN 

Asked to start something, but ARM is shutting down and can't comply.

Definition at line 99 of file gnunet_arm_service.h.

99  {
104 
109 
114 
119 
124 
129 
134 
139 
144 
149 };
ARM stopping was initiated (there's no "stopped" for ARM itself).
Asked to stop it, but it's already stopping.
Asked to start it, but it's already started.
Tried to start a service, but that failed for some reason.
Service starting was initiated.
Asked to start it, but it's already starting.
Asked to start something, but ARM is shutting down and can't comply.
Asked to stop it, but it's already stopped.
Asked to start or stop a service, but it's not known.
Service was stopped (never sent for ARM itself).

Function Documentation

◆ GNUNET_ARM_connect()

struct GNUNET_ARM_Handle* GNUNET_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.

Parameters
cfgconfiguration to use (needed to contact ARM; the ARM service may internally use a different configuration to determine how to start the service).
conn_statuswill be called when connecting/disconnecting
conn_status_clsclosure for conn_status
Returns
context to use for further ARM operations, NULL on error.

Definition at line 480 of file arm_api.c.

References cfg, GNUNET_ARM_Handle::cfg, GNUNET_ARM_Handle::conn_status, conn_status(), GNUNET_ARM_Handle::conn_status_cls, GNUNET_free, GNUNET_new, GNUNET_OK, GNUNET_ARM_Operation::h, and reconnect_arm().

Referenced by GNUNET_TESTING_peer_stop_async(), handle_manage_peer_service(), and run().

483 {
484  struct GNUNET_ARM_Handle *h;
485 
486  h = GNUNET_new(struct GNUNET_ARM_Handle);
487  h->cfg = cfg;
490  if (GNUNET_OK != reconnect_arm(h))
491  {
492  GNUNET_free(h);
493  return NULL;
494  }
495  return h;
496 }
const struct GNUNET_CONFIGURATION_Handle * cfg
The configuration that we are using.
Definition: arm_api.c:105
Handle for interacting with ARM.
Definition: arm_api.c:96
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_new(type)
Allocate a struct or union of the given type.
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
GNUNET_ARM_ConnectionStatusCallback conn_status
Callback to invoke on connection/disconnection.
Definition: arm_api.c:120
static void conn_status(void *cls, int connected)
Function called whenever we connect to or disconnect from ARM.
Definition: gnunet-arm.c:296
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:104
void * conn_status_cls
Closure for conn_status.
Definition: arm_api.c:125
static int reconnect_arm(struct GNUNET_ARM_Handle *h)
Connect to arm.
Definition: arm_api.c:431
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_ARM_disconnect()

void GNUNET_ARM_disconnect ( struct GNUNET_ARM_Handle h)

Disconnect from the ARM service and destroy the handle.

Parameters
hthe handle that was being used

Disconnect from the ARM service and destroy the handle.

Parameters
hthe handle that was being used

Definition at line 505 of file arm_api.c.

References GNUNET_ARM_Operation::async, GNUNET_ARM_Operation::cont_cls, GNUNET_ARM_REQUEST_DISCONNECTED, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_cancel(), GNUNET_ARM_Operation::list_cont, LOG, GNUNET_ARM_Handle::mq, op, GNUNET_ARM_Handle::operation_pending_head, GNUNET_ARM_Handle::operation_pending_tail, GNUNET_ARM_Handle::reconnect_task, and GNUNET_ARM_Operation::result_cont.

Referenced by cleanup_mctx(), disconn_status(), GNUNET_TESTING_peer_destroy(), GNUNET_TESTING_peer_stop_async_cancel(), and shutdown_task().

506 {
507  struct GNUNET_ARM_Operation *op;
508 
509  LOG(GNUNET_ERROR_TYPE_DEBUG, "Disconnecting from ARM service\n");
510  while (NULL != (op = h->operation_pending_head))
511  {
514  op);
515  if (NULL != op->result_cont)
517  if (NULL != op->list_cont)
519  if (NULL != op->async)
520  {
522  op->async = NULL;
523  }
524  GNUNET_free(op);
525  }
526  if (NULL != h->mq)
527  {
528  GNUNET_MQ_destroy(h->mq);
529  h->mq = NULL;
530  }
531  if (NULL != h->reconnect_task)
532  {
534  h->reconnect_task = NULL;
535  }
536  GNUNET_free(h);
537 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
struct GNUNET_SCHEDULER_Task * reconnect_task
ID of the reconnect task (if any).
Definition: arm_api.c:140
#define LOG(kind,...)
Definition: arm_api.c:33
Entry in a doubly-linked list of operations awaiting for replies (in-order) from the ARM service...
Definition: arm_api.c:40
We disconnected from ARM, and request was not sent.
struct GNUNET_MQ_Handle * mq
Our connection to the ARM service.
Definition: arm_api.c:100
void * cont_cls
Closure for result_cont or list_cont.
Definition: arm_api.c:69
struct GNUNET_SCHEDULER_Task * async
Task for async completion.
Definition: arm_api.c:74
GNUNET_ARM_ServiceListCallback list_cont
Callback for service list requests.
Definition: arm_api.c:64
struct GNUNET_ARM_Operation * operation_pending_head
Head of doubly-linked list of pending operations.
Definition: arm_api.c:110
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:821
struct GNUNET_ARM_Operation * operation_pending_tail
Tail of doubly-linked list of pending operations.
Definition: arm_api.c:115
static struct GNUNET_ARM_Operation * op
Current operation.
Definition: gnunet-arm.c:139
GNUNET_ARM_ResultCallback result_cont
Callback for service state change requests.
Definition: arm_api.c:59
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_ARM_operation_cancel()

void GNUNET_ARM_operation_cancel ( struct GNUNET_ARM_Operation op)

Abort an operation.

Only prevents the callback from being called, the operation may still complete.

Parameters
opoperation to cancel

Definition at line 663 of file arm_api.c.

References GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_ARM_Operation::h, GNUNET_ARM_Handle::operation_pending_head, GNUNET_ARM_Handle::operation_pending_tail, GNUNET_ARM_Operation::result_cont, and GNUNET_ARM_Handle::thm.

Referenced by handle_arm_list_result(), handle_arm_result(), reconnect_arm_later(), and shutdown_task().

664 {
665  struct GNUNET_ARM_Handle *h = op->h;
666 
667  if (h->thm == op)
668  {
669  op->result_cont = NULL;
670  return;
671  }
674  op);
675  GNUNET_free(op);
676 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
Handle for interacting with ARM.
Definition: arm_api.c:96
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
struct GNUNET_ARM_Operation * operation_pending_head
Head of doubly-linked list of pending operations.
Definition: arm_api.c:110
struct GNUNET_ARM_Operation * thm
ARM operation where the goal is to wait for ARM shutdown to complete.
Definition: arm_api.c:135
struct GNUNET_ARM_Handle * h
ARM handle.
Definition: arm_api.c:54
struct GNUNET_ARM_Operation * operation_pending_tail
Tail of doubly-linked list of pending operations.
Definition: arm_api.c:115
GNUNET_ARM_ResultCallback result_cont
Callback for service state change requests.
Definition: arm_api.c:59
#define GNUNET_free(ptr)
Wrapper around free.
Here is the caller graph for this function:

◆ GNUNET_ARM_request_service_list()

struct GNUNET_ARM_Operation* GNUNET_ARM_request_service_list ( struct GNUNET_ARM_Handle h,
GNUNET_ARM_ServiceListCallback  cont,
void *  cont_cls 
)

Request a list of running services.

Parameters
hhandle to ARM
contcallback to invoke after request is sent or is not sent
cont_clsclosure for cont
Returns
handle for the operation, NULL on error

Definition at line 894 of file arm_api.c.

References GNUNET_ARM_Operation::cont_cls, env, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_ERROR_TYPE_DEBUG, GNUNET_htonll(), GNUNET_MESSAGE_TYPE_ARM_LIST, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_new, GNUNET_ARM_Operation::h, GNUNET_ARM_Operation::id, GNUNET_ARM_Operation::list_cont, LOG, GNUNET_ARM_Handle::mq, msg, op, GNUNET_ARM_Handle::operation_pending_head, GNUNET_ARM_Handle::operation_pending_tail, GNUNET_ARM_Message::request_id, GNUNET_ARM_Handle::request_id_counter, and GNUNET_ARM_Message::reserved.

Referenced by action_loop().

897 {
898  struct GNUNET_ARM_Operation *op;
899  struct GNUNET_MQ_Envelope *env;
900  struct GNUNET_ARM_Message *msg;
901 
902  LOG(GNUNET_ERROR_TYPE_DEBUG, "Requesting LIST from ARM service\n");
903  if (0 == h->request_id_counter)
904  h->request_id_counter++;
905  op = GNUNET_new(struct GNUNET_ARM_Operation);
906  op->h = h;
907  op->list_cont = cont;
908  op->cont_cls = cont_cls;
909  op->id = h->request_id_counter++;
912  op);
914  msg->reserved = htonl(0);
915  msg->request_id = GNUNET_htonll(op->id);
916  GNUNET_MQ_send(h->mq, env);
917  return op;
918 }
struct GNUNET_MessageHeader * msg
Definition: 005.c:2
uint64_t request_id
ID of a request that is being replied to.
Definition: arm.h:75
#define LOG(kind,...)
Definition: arm_api.c:33
Entry in a doubly-linked list of operations awaiting for replies (in-order) from the ARM service...
Definition: arm_api.c:40
#define GNUNET_MQ_msg(mvar, type)
Allocate a GNUNET_MQ_Envelope.
Definition: gnunet_mq_lib.h:67
struct GNUNET_MQ_Handle * mq
Our connection to the ARM service.
Definition: arm_api.c:100
#define GNUNET_new(type)
Allocate a struct or union of the given type.
void * cont_cls
Closure for result_cont or list_cont.
Definition: arm_api.c:69
uint32_t reserved
For alignment.
Definition: arm.h:68
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
GNUNET_ARM_ServiceListCallback list_cont
Callback for service list requests.
Definition: arm_api.c:64
struct GNUNET_ARM_Operation * operation_pending_head
Head of doubly-linked list of pending operations.
Definition: arm_api.c:110
uint64_t GNUNET_htonll(uint64_t n)
Convert unsigned 64-bit integer to network byte order.
Definition: common_endian.c:35
#define GNUNET_MESSAGE_TYPE_ARM_LIST
Request to ARM to list all currently running services.
uint64_t id
Unique ID for the request.
Definition: arm_api.c:79
struct GNUNET_MQ_Envelope * env
Definition: 005.c:1
#define GNUNET_CONTAINER_DLL_insert_tail(head, tail, element)
Insert an element at the tail of a DLL.
struct GNUNET_ARM_Handle * h
ARM handle.
Definition: arm_api.c:54
uint64_t request_id_counter
Counter for request identifiers.
Definition: arm_api.c:151
void GNUNET_MQ_send(struct GNUNET_MQ_Handle *mq, struct GNUNET_MQ_Envelope *ev)
Send a message with the given message queue.
Definition: mq.c:351
struct GNUNET_ARM_Operation * operation_pending_tail
Tail of doubly-linked list of pending operations.
Definition: arm_api.c:115
static struct GNUNET_ARM_Operation * op
Current operation.
Definition: gnunet-arm.c:139
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_ARM_request_service_stop()

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 
)

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.

Parameters
hhandle to ARM
service_namename of the service
contcallback to invoke after request is sent or is not sent
cont_clsclosure for cont
Returns
handle for the operation, NULL on error

Definition at line 862 of file arm_api.c.

References change_service(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_MESSAGE_TYPE_ARM_STOP, GNUNET_YES, GNUNET_ARM_Operation::is_arm_stop, LOG, and op.

Referenced by action_loop(), and handle_manage_peer_service().

866 {
867  struct GNUNET_ARM_Operation *op;
868 
869  LOG(GNUNET_ERROR_TYPE_DEBUG, "Stopping service `%s'\n", service_name);
870  op = change_service(h,
871  service_name,
872  cont,
873  cont_cls,
875  if (NULL == op)
876  return NULL;
877  /* If the service is ARM, set a flag as we will use MQ errors
878  to detect that the process is really gone. */
879  if (0 == strcasecmp(service_name, "arm"))
880  op->is_arm_stop = GNUNET_YES;
881  return op;
882 }
#define LOG(kind,...)
Definition: arm_api.c:33
Entry in a doubly-linked list of operations awaiting for replies (in-order) from the ARM service...
Definition: arm_api.c:40
#define GNUNET_MESSAGE_TYPE_ARM_STOP
Request to ARM to stop a service.
void * cont_cls
Closure for result_cont or list_cont.
Definition: arm_api.c:69
static struct GNUNET_ARM_Operation * change_service(struct GNUNET_ARM_Handle *h, const char *service_name, GNUNET_ARM_ResultCallback cb, void *cb_cls, uint16_t type)
Start or stop a service.
Definition: arm_api.c:690
static char * service_name
Option -s: service name (hash to get service descriptor)
Definition: gnunet-vpn.c:51
int is_arm_stop
Is this an operation to stop the ARM service?
Definition: arm_api.c:89
#define GNUNET_YES
Definition: gnunet_common.h:77
static struct GNUNET_ARM_Operation * op
Current operation.
Definition: gnunet-arm.c:139
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_ARM_request_service_start()

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 
)

Request for a service to be started.

Parameters
hhandle to ARM
service_namename of the service
std_inheritanceinheritance of std streams
contcallback to invoke after request is sent or not sent
cont_clsclosure for cont
Returns
handle for the operation, NULL on error

Definition at line 787 of file arm_api.c.

References GNUNET_ARM_Operation::async, change_service(), GNUNET_ARM_Operation::cont_cls, GNUNET_ARM_Handle::currently_up, GNUNET_ARM_RESULT_STARTING, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_ERROR_TYPE_DEBUG, GNUNET_MESSAGE_TYPE_ARM_START, GNUNET_new, GNUNET_SCHEDULER_add_now(), GNUNET_YES, GNUNET_ARM_Operation::h, LOG, notify_running(), notify_starting(), op, GNUNET_ARM_Handle::operation_pending_head, GNUNET_ARM_Handle::operation_pending_tail, reconnect_arm(), GNUNET_ARM_Operation::result_cont, ret, start_arm_service(), and GNUNET_ARM_Operation::starting_ret.

Referenced by action_loop(), and handle_manage_peer_service().

793 {
794  struct GNUNET_ARM_Operation *op;
795  enum GNUNET_ARM_Result ret;
796 
797  LOG(GNUNET_ERROR_TYPE_DEBUG, "Starting service `%s'\n", service_name);
798  if (0 != strcasecmp("arm", service_name))
799  return change_service(h,
800  service_name,
801  cont,
802  cont_cls,
804 
805  /* Possible cases:
806  * 1) We're connected to ARM already. Invoke the callback immediately.
807  * 2) We're not connected to ARM.
808  * Cancel any reconnection attempts temporarily, then perform
809  * a service test.
810  */
811  if (GNUNET_YES == h->currently_up)
812  {
813  LOG(GNUNET_ERROR_TYPE_DEBUG, "ARM is already running\n");
814  op = GNUNET_new(struct GNUNET_ARM_Operation);
815  op->h = h;
816  op->result_cont = cont;
817  op->cont_cls = cont_cls;
820  op);
822  return op;
823  }
824  /* This is an inherently uncertain choice, as it is of course
825  theoretically possible that ARM is up and we just did not
826  yet complete the MQ handshake. However, given that users
827  are unlikely to hammer 'gnunet-arm -s' on a busy system,
828  the above check should catch 99.99% of the cases where ARM
829  is already running. */
830  LOG(GNUNET_ERROR_TYPE_DEBUG, "Starting ARM service\n");
831  ret = start_arm_service(h, std_inheritance);
832  if (GNUNET_ARM_RESULT_STARTING == ret)
833  reconnect_arm(h);
834  op = GNUNET_new(struct GNUNET_ARM_Operation);
835  op->h = h;
836  op->result_cont = cont;
837  op->cont_cls = cont_cls;
840  op);
841  op->starting_ret = ret;
843  return op;
844 }
static void notify_starting(void *cls)
Task run to notify application that ARM is being started.
Definition: arm_api.c:757
#define LOG(kind,...)
Definition: arm_api.c:33
Entry in a doubly-linked list of operations awaiting for replies (in-order) from the ARM service...
Definition: arm_api.c:40
#define GNUNET_MESSAGE_TYPE_ARM_START
Request to ARM to start a service.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
GNUNET_ARM_Result
Replies to ARM requests.
void * cont_cls
Closure for result_cont or list_cont.
Definition: arm_api.c:69
static int ret
Final status code.
Definition: gnunet-arm.c:89
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
struct GNUNET_SCHEDULER_Task * async
Task for async completion.
Definition: arm_api.c:74
static void notify_running(void *cls)
Task run to notify application that ARM is already up.
Definition: arm_api.c:732
Service starting was initiated.
static struct GNUNET_ARM_Operation * change_service(struct GNUNET_ARM_Handle *h, const char *service_name, GNUNET_ARM_ResultCallback cb, void *cb_cls, uint16_t type)
Start or stop a service.
Definition: arm_api.c:690
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1264
static char * service_name
Option -s: service name (hash to get service descriptor)
Definition: gnunet-vpn.c:51
struct GNUNET_ARM_Operation * operation_pending_head
Head of doubly-linked list of pending operations.
Definition: arm_api.c:110
static enum GNUNET_ARM_Result start_arm_service(struct GNUNET_ARM_Handle *h, enum GNUNET_OS_InheritStdioFlags std_inheritance)
A client specifically requested starting of ARM itself.
Definition: arm_api.c:549
#define GNUNET_CONTAINER_DLL_insert_tail(head, tail, element)
Insert an element at the tail of a DLL.
struct GNUNET_ARM_Handle * h
ARM handle.
Definition: arm_api.c:54
int currently_up
Have we detected that ARM is up?
Definition: arm_api.c:156
enum GNUNET_ARM_Result starting_ret
Result of this operation for notify_starting().
Definition: arm_api.c:84
#define GNUNET_YES
Definition: gnunet_common.h:77
struct GNUNET_ARM_Operation * operation_pending_tail
Tail of doubly-linked list of pending operations.
Definition: arm_api.c:115
static struct GNUNET_ARM_Operation * op
Current operation.
Definition: gnunet-arm.c:139
static int reconnect_arm(struct GNUNET_ARM_Handle *h)
Connect to arm.
Definition: arm_api.c:431
GNUNET_ARM_ResultCallback result_cont
Callback for service state change requests.
Definition: arm_api.c:59
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_ARM_monitor_start()

struct GNUNET_ARM_MonitorHandle* GNUNET_ARM_monitor_start ( const struct GNUNET_CONFIGURATION_Handle cfg,
GNUNET_ARM_ServiceStatusCallback  cont,
void *  cont_cls 
)

Setup a context for monitoring ARM, then start connecting to the ARM service for monitoring using that context.

Parameters
cfgconfiguration to use (needed to contact ARM; the ARM service may internally use a different configuration to determine how to start the service).
contcallback to invoke on status updates
cont_clsclosure for cont
Returns
context to use for further ARM monitor operations, NULL on error.

Definition at line 232 of file arm_monitor_api.c.

References GNUNET_ARM_MonitorHandle::cfg, GNUNET_free, GNUNET_new, GNUNET_OK, h, reconnect_arm_monitor(), GNUNET_ARM_MonitorHandle::service_status, and GNUNET_ARM_MonitorHandle::service_status_cls.

Referenced by run().

235 {
236  struct GNUNET_ARM_MonitorHandle *h;
237 
239  h->cfg = cfg;
240  h->service_status = cont;
241  h->service_status_cls = cont_cls;
243  {
244  GNUNET_free(h);
245  return NULL;
246  }
247  return h;
248 }
void * service_status_cls
Closure for service_status.
const struct GNUNET_CONFIGURATION_Handle * cfg
The configuration that we are using.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Handle for interacting with ARM.
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:104
GNUNET_ARM_ServiceStatusCallback service_status
Callback to invoke on status updates.
static int reconnect_arm_monitor(struct GNUNET_ARM_MonitorHandle *h)
Connect to the ARM service for monitoring.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_ARM_monitor_stop()

void GNUNET_ARM_monitor_stop ( struct GNUNET_ARM_MonitorHandle h)

Disconnect from the ARM service and destroy the handle.

Parameters
hthe handle that was being used

Disconnect from the ARM service and destroy the handle.

Parameters
hthe handle that was being used

Definition at line 257 of file arm_monitor_api.c.

References GNUNET_free, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_cancel(), GNUNET_ARM_MonitorHandle::mq, and GNUNET_ARM_MonitorHandle::reconnect_task.

Referenced by shutdown_task().

258 {
259  if (NULL != h->mq)
260  {
261  GNUNET_MQ_destroy(h->mq);
262  h->mq = NULL;
263  }
264  if (NULL != h->reconnect_task)
265  {
267  h->reconnect_task = NULL;
268  }
269  GNUNET_free(h);
270 }
struct GNUNET_SCHEDULER_Task * reconnect_task
ID of the reconnect task (if any).
struct GNUNET_MQ_Handle * mq
Our control connection to the ARM service.
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:821
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function: