arm_monitor_api.c File Reference

API for monitoring the ARM service. More...

#include "platform.h"
#include "gnunet_arm_service.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
#include "arm.h"

Include dependency graph for arm_monitor_api.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_ARM_MonitorHandle
	Handle for interacting with ARM. More...

Macros
#define	INIT_TIMEOUT   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)
#define	LOG(kind, ...)   GNUNET_log_from (kind, "arm-monitor-api", __VA_ARGS__)

Functions
static int	reconnect_arm_monitor (struct GNUNET_ARM_MonitorHandle *h)
	Connect to the ARM service for monitoring.
static void	reconnect_arm_monitor_task (void *cls)
	Task scheduled to try to re-connect to arm.
static void	reconnect_arm_monitor_later (struct GNUNET_ARM_MonitorHandle *h)
	Close down any existing connection to the ARM service and try re-establishing it later.
static int	check_monitor_notify (void *cls, const struct GNUNET_ARM_StatusMessage *msg)
	Check notification messages received from ARM is well-formed.
static void	handle_monitor_notify (void *cls, const struct GNUNET_ARM_StatusMessage *res)
	Handler for notification messages received from ARM.
static void	mq_error_handler (void *cls, enum GNUNET_MQ_Error error)
	Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue.
struct GNUNET_ARM_MonitorHandle *	GNUNET_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.
void	GNUNET_ARM_monitor_stop (struct GNUNET_ARM_MonitorHandle *h)
	Disconnect from the ARM service (if connected) and destroy the context.

Detailed Description

API for monitoring the ARM service.

Author

Christian Grothoff

LRN

Definition in file arm_monitor_api.c.

Macro Definition Documentation

INIT_TIMEOUT

#define INIT_TIMEOUT   GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5)

Definition at line 33 of file arm_monitor_api.c.

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log_from (kind, "arm-monitor-api", __VA_ARGS__)

Definition at line 35 of file arm_monitor_api.c.

Function Documentation

reconnect_arm_monitor()

static int reconnect_arm_monitor ( struct GNUNET_ARM_MonitorHandle *  h )

static

Connect to the ARM service for monitoring.

Parameters

h	handle to connect

Returns

GNUNET_OK on success

Definition at line 194 of file arm_monitor_api.c.

{
  struct GNUNET_MQ_MessageHandler handlers[] =
  { GNUNET_MQ_hd_var_size (monitor_notify,
                           GNUNET_MESSAGE_TYPE_ARM_STATUS,
                           struct GNUNET_ARM_StatusMessage,
                           h),
    GNUNET_MQ_handler_end () };
  struct GNUNET_MessageHeader *msg;
  struct GNUNET_MQ_Envelope *env;
 
  GNUNET_assert (NULL == h->mq);
  h->mq = GNUNET_CLIENT_connect (h->cfg, "arm", handlers, &mq_error_handler, h);
  if (NULL == h->mq)
  {
    if (NULL != h->service_status)
      h->service_status (h->service_status_cls,
                         NULL,
                         GNUNET_ARM_SERVICE_STOPPED);
    return GNUNET_SYSERR;
  }
  env = GNUNET_MQ_msg (msg, GNUNET_MESSAGE_TYPE_ARM_MONITOR);
  GNUNET_MQ_send (h->mq, env);
  return GNUNET_OK;
}

References GNUNET_ARM_Handle::cfg, env, GNUNET_ARM_SERVICE_STOPPED, GNUNET_assert, GNUNET_CLIENT_connect(), GNUNET_MESSAGE_TYPE_ARM_MONITOR, GNUNET_MESSAGE_TYPE_ARM_STATUS, GNUNET_MQ_handler_end, GNUNET_MQ_hd_var_size, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_OK, GNUNET_SYSERR, h, handlers, GNUNET_ARM_Handle::mq, mq_error_handler(), and msg.

Referenced by GNUNET_ARM_monitor_start(), and reconnect_arm_monitor_task().

Here is the call graph for this function:

Here is the caller graph for this function:

reconnect_arm_monitor_task()

static void reconnect_arm_monitor_task ( void *  cls )

static

Task scheduled to try to re-connect to arm.

Parameters

cls	the struct GNUNET_ARM_MonitorHandle

Definition at line 90 of file arm_monitor_api.c.

{
  struct GNUNET_ARM_MonitorHandle *h = cls;
 
  h->reconnect_task = NULL;
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Connecting to ARM service for monitoring after delay\n");
  GNUNET_break (GNUNET_OK == reconnect_arm_monitor (h));
}

References GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_OK, h, LOG, reconnect_arm_monitor(), and GNUNET_ARM_Handle::reconnect_task.

Referenced by reconnect_arm_monitor_later().

Here is the call graph for this function:

Here is the caller graph for this function:

reconnect_arm_monitor_later()

static void reconnect_arm_monitor_later ( struct GNUNET_ARM_MonitorHandle *  h )

static

Close down any existing connection to the ARM service and try re-establishing it later.

Parameters

h	our handle

Definition at line 108 of file arm_monitor_api.c.

{
  if (NULL != h->mq)
  {
    GNUNET_MQ_destroy (h->mq);
    h->mq = NULL;
  }
  GNUNET_assert (NULL == h->reconnect_task);
  h->reconnect_task = GNUNET_SCHEDULER_add_delayed (h->retry_backoff,
                                                    &reconnect_arm_monitor_task,
                                                    h);
  h->retry_backoff = GNUNET_TIME_STD_BACKOFF (h->retry_backoff);
}

References GNUNET_assert, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_add_delayed(), GNUNET_TIME_STD_BACKOFF, h, GNUNET_ARM_Handle::mq, reconnect_arm_monitor_task(), GNUNET_ARM_Handle::reconnect_task, and GNUNET_ARM_Handle::retry_backoff.

Referenced by mq_error_handler().

Here is the call graph for this function:

Here is the caller graph for this function:

check_monitor_notify()

static int check_monitor_notify ( void *  cls, const struct GNUNET_ARM_StatusMessage *  msg  )

static

Check notification messages received from ARM is well-formed.

Parameters

cls	our struct GNUNET_ARM_MonitorHandle
msg	the message received from the arm service

Returns

GNUNET_OK if the message is well-formed

Definition at line 131 of file arm_monitor_api.c.

{
  size_t sl =
    ntohs (msg->header.size) - sizeof(struct GNUNET_ARM_StatusMessage);
  const char *name = (const char *) &msg[1];
 
  (void) cls;
  if ((0 == sl) || ('\0' != name[sl - 1]))
  {
    GNUNET_break (0);
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}

References GNUNET_break, GNUNET_OK, GNUNET_SYSERR, msg, name, and GNUNET_MessageHeader::size.

handle_monitor_notify()

static void handle_monitor_notify ( void *  cls, const struct GNUNET_ARM_StatusMessage *  res  )

static

Handler for notification messages received from ARM.

Parameters

cls	our struct GNUNET_ARM_MonitorHandle
res	the message received from the arm service

Definition at line 154 of file arm_monitor_api.c.

{
  struct GNUNET_ARM_MonitorHandle *h = cls;
  enum GNUNET_ARM_ServiceMonitorStatus status;
 
  status = ntohl (res->status);
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Received notification from ARM for service `%s' with status %d\n",
       (const char *) &res[1],
       (int) status);
  if (NULL != h->service_status)
    h->service_status (h->service_status_cls, (const char *) &res[1], status);
}

References GNUNET_ERROR_TYPE_DEBUG, h, LOG, res, and status.

mq_error_handler()

static void mq_error_handler ( void *  cls, enum GNUNET_MQ_Error  error  )

static

Generic error handler, called with the appropriate error code and the same closure specified at the creation of the message queue.

Not every message queue implementation supports an error handler.

Parameters

cls	closure with the struct GNUNET_ARM_MonitorHandle *
error	error code

Definition at line 178 of file arm_monitor_api.c.

{
  struct GNUNET_ARM_MonitorHandle *h = cls;
 
  (void) error;
  reconnect_arm_monitor_later (h);
}

References h, and reconnect_arm_monitor_later().

Referenced by reconnect_arm_monitor().

Here is the call graph for this function:

Here is the caller graph for this function: