testbed_api_services.c File Reference

convenience functions for accessing services More...

#include "platform.h"
#include "testbed_api.h"
#include "testbed_api_peers.h"
#include "testbed_api_operations.h"

Include dependency graph for testbed_api_services.c:

Go to the source code of this file.

Data Structures
struct	ServiceConnectData
	Data accessed during service connections. More...

Enumerations
enum	State {   STATE_INIT = 0 , STATE_SLAVES_STARTING , STATE_PEERS_CREATING , STATE_PEERS_STARTING ,   STATE_PEERS_LINKING , STATE_SEARCH_REGEX , STATE_PEERS_DESTROYING , INIT ,   CFG_REQUEST_QUEUED , SERVICE_CONNECTED , RC_INIT = 0 , RC_LINKED ,   RC_PEERS_CREATED , RC_READY , RC_PEERS_SHUTDOWN }
	States for Service connect operations. More...

Functions
static void	configuration_receiver (void *cls, const struct GNUNET_MessageHeader *msg)
	Type of a function to call when we receive a message from the service. More...
static void	opstart_service_connect (void *cls)
	Function called when a service connect operation is ready. More...
static void	oprelease_service_connect (void *cls)
	Callback which will be called when service connect type operation is released. More...
struct GNUNET_TESTBED_Operation *	GNUNET_TESTBED_service_connect (void *op_cls, struct GNUNET_TESTBED_Peer *peer, const char *service_name, GNUNET_TESTBED_ServiceConnectCompletionCallback cb, void *cb_cls, GNUNET_TESTBED_ConnectAdapter ca, GNUNET_TESTBED_DisconnectAdapter da, void *cada_cls)
	Connect to a service offered by the given peer. More...

Detailed Description

convenience functions for accessing services

Author

Christian Grothoff

Definition in file testbed_api_services.c.

Enumeration Type Documentation

State

enum State

States for Service connect operations.

Enumerator
STATE_INIT	Initial state.
STATE_SLAVES_STARTING	Starting slaves.
STATE_PEERS_CREATING	Creating peers.
STATE_PEERS_STARTING	Starting peers.
STATE_PEERS_LINKING	Linking peers.
STATE_SEARCH_REGEX	Matching strings against announced regexes.
STATE_PEERS_DESTROYING	Destroying peers; we can do this as the controller takes care of stopping a peer if it is running.
INIT	Initial state.
CFG_REQUEST_QUEUED	The configuration request has been sent.
SERVICE_CONNECTED	connected to service
RC_INIT	Initial state.
RC_LINKED	Controllers on given hosts started and linked.
RC_PEERS_CREATED	Peers are created.
RC_READY	The testbed run is ready and the master callback can be called now. At this time the peers are all started and if a topology is provided in the configuration the topology would have been attempted
RC_PEERS_SHUTDOWN	All peers shutdown (stopped and destroyed)

Definition at line 35 of file testbed_api_services.c.

{
  INIT,
 
  CFG_REQUEST_QUEUED,
 
  SERVICE_CONNECTED
};

Function Documentation

configuration_receiver()

static void configuration_receiver ( void *  cls, const struct GNUNET_MessageHeader *  msg  )

static

Type of a function to call when we receive a message from the service.

Parameters

cls	ServiceConnectData
msg	message received, NULL on timeout or fatal error

Definition at line 134 of file testbed_api_services.c.

{
  struct ServiceConnectData *data = cls;
  struct GNUNET_TESTBED_Controller *c;
  const char *emsg;
  struct GNUNET_TESTBED_EventInformation info;
  uint16_t mtype;
 
  c = data->peer->controller;
  mtype = ntohs (msg->type);
  emsg = NULL;
  info.type = GNUNET_TESTBED_ET_OPERATION_FINISHED;
  info.op = data->operation;
  info.op_cls = data->op_cls;
  if (GNUNET_MESSAGE_TYPE_TESTBED_OPERATION_FAIL_EVENT == mtype)
  {
    emsg =
      GNUNET_TESTBED_parse_error_string_ ((const struct
                                           GNUNET_TESTBED_OperationFailureEventMessage
                                           *) msg);
    if (NULL == emsg)
      emsg = "Unknown error";
    info.details.operation_finished.emsg = emsg;
    info.details.operation_finished.generic = NULL;
    goto call_cb;
  }
  data->cfg = GNUNET_TESTBED_extract_config_ (msg);
  GNUNET_assert (NULL == data->op_result);
  data->op_result = data->ca (data->cada_cls, data->cfg);
  info.details.operation_finished.emsg = NULL;
  info.details.operation_finished.generic = data->op_result;
  data->state = SERVICE_CONNECTED;
 
call_cb:
  if ((0 != (GNUNET_TESTBED_ET_OPERATION_FINISHED & c->event_mask)) &&
      (NULL != c->cc))
    c->cc (c->cc_cls, &info);
  if (NULL != data->cb)
    data->cb (data->cb_cls, data->operation, data->op_result, emsg);
}

References GNUNET_TESTBED_Controller::cc, GNUNET_TESTBED_Controller::cc_cls, data, GNUNET_TESTBED_EventInformation::emsg, GNUNET_TESTBED_Controller::event_mask, GNUNET_assert, GNUNET_MESSAGE_TYPE_TESTBED_OPERATION_FAIL_EVENT, GNUNET_TESTBED_ET_OPERATION_FINISHED, GNUNET_TESTBED_extract_config_(), GNUNET_TESTBED_parse_error_string_(), info, msg, SERVICE_CONNECTED, and GNUNET_MessageHeader::type.

Referenced by opstart_service_connect().

Here is the call graph for this function:

Here is the caller graph for this function:

opstart_service_connect()

static void opstart_service_connect ( void *  cls )

static

Function called when a service connect operation is ready.

Parameters

cls	the closure from GNUNET_TESTBED_operation_create_()

Definition at line 182 of file testbed_api_services.c.

{
  struct ServiceConnectData *data = cls;
  struct GNUNET_TESTBED_PeerGetConfigurationMessage *msg;
  struct GNUNET_TESTBED_Controller *c;
  uint64_t op_id;
 
  GNUNET_assert (NULL != data);
  GNUNET_assert (NULL != data->peer);
  c = data->peer->controller;
  op_id = GNUNET_TESTBED_get_next_op_id (c);
  msg =
    GNUNET_TESTBED_generate_peergetconfig_msg_ (data->peer->unique_id, op_id);
  data->opc =
    GNUNET_TESTBED_forward_operation_msg_ (c, op_id, &msg->header,
                                           &configuration_receiver, data);
  GNUNET_free (msg);
  data->state = CFG_REQUEST_QUEUED;
}

References CFG_REQUEST_QUEUED, configuration_receiver(), data, GNUNET_assert, GNUNET_free, GNUNET_TESTBED_forward_operation_msg_(), GNUNET_TESTBED_generate_peergetconfig_msg_(), GNUNET_TESTBED_get_next_op_id(), and msg.

Referenced by GNUNET_TESTBED_service_connect().

Here is the call graph for this function:

Here is the caller graph for this function:

oprelease_service_connect()

static void oprelease_service_connect ( void *  cls )

static

Callback which will be called when service connect type operation is released.

Parameters

cls	the closure from GNUNET_TESTBED_operation_create_()

Definition at line 210 of file testbed_api_services.c.

{
  struct ServiceConnectData *data = cls;
 
  switch (data->state)
  {
  case INIT:
    break;
 
  case CFG_REQUEST_QUEUED:
    GNUNET_assert (NULL != data->opc);
    GNUNET_TESTBED_forward_operation_msg_cancel_ (data->opc);
    break;
 
  case SERVICE_CONNECTED:
    GNUNET_assert (NULL != data->cfg);
    GNUNET_CONFIGURATION_destroy (data->cfg);
    if (NULL != data->da)
      data->da (data->cada_cls, data->op_result);
    break;
  }
  GNUNET_free (data);
}

References CFG_REQUEST_QUEUED, data, GNUNET_assert, GNUNET_CONFIGURATION_destroy(), GNUNET_free, GNUNET_TESTBED_forward_operation_msg_cancel_(), INIT, and SERVICE_CONNECTED.

Referenced by GNUNET_TESTBED_service_connect().

Here is the call graph for this function:

Here is the caller graph for this function: