ats_api_connectivity.c File Reference

enable clients to ask ATS about establishing connections to peers More...

#include "platform.h"
#include "gnunet_ats_service.h"
#include "ats.h"

Include dependency graph for ats_api_connectivity.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_ATS_ConnectivitySuggestHandle
	Handle for ATS address suggestion requests. More...
struct	GNUNET_ATS_ConnectivityHandle
	Handle to the ATS subsystem for connectivity management. More...

Macros
#define	LOG(kind, ...)

Functions
static void	reconnect (struct GNUNET_ATS_ConnectivityHandle *ch)
	Re-establish the connection to the ATS service. More...
static void	reconnect_task (void *cls)
	Re-establish the connection to the ATS service. More...
static void	force_reconnect (struct GNUNET_ATS_ConnectivityHandle *ch)
	Disconnect from ATS and then reconnect. More...
static void	error_handler (void *cls, enum GNUNET_MQ_Error error)
	We encountered an error handling the MQ to the ATS service. More...
static int	transmit_suggestion (void *cls, const struct GNUNET_PeerIdentity *peer, void *value)
	Transmit request for an address suggestion. More...
struct GNUNET_ATS_ConnectivityHandle *	GNUNET_ATS_connectivity_init (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Initialize the ATS connectivity suggestion client handle. More...
static int	free_sug_handle (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
	Function called to free all struct GNUNET_ATS_ConnectivitySuggestHandles in the map. More...
void	GNUNET_ATS_connectivity_done (struct GNUNET_ATS_ConnectivityHandle *ch)
	Client is done with ATS connectivity management, release resources. More...
struct GNUNET_ATS_ConnectivitySuggestHandle *	GNUNET_ATS_connectivity_suggest (struct GNUNET_ATS_ConnectivityHandle *ch, const struct GNUNET_PeerIdentity *peer, uint32_t strength)
	We would like to receive address suggestions for a peer. More...
void	GNUNET_ATS_connectivity_suggest_cancel (struct GNUNET_ATS_ConnectivitySuggestHandle *sh)
	We no longer care about being connected to a peer. More...

Detailed Description

enable clients to ask ATS about establishing connections to peers

Author

Christian Grothoff

Matthias Wachs

Definition in file ats_api_connectivity.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)

Value:

                                        GNUNET_log_from (kind, "ats-connectivity-api", \
                                        __VA_ARGS__)

Definition at line 31 of file ats_api_connectivity.c.

Function Documentation

reconnect()

static void reconnect ( struct GNUNET_ATS_ConnectivityHandle *  ch )

static

Re-establish the connection to the ATS service.

Parameters

ch	handle to use to re-connect.

Definition at line 190 of file ats_api_connectivity.c.

{
  static const struct GNUNET_MQ_MessageHandler handlers[] =
  { { NULL, 0, 0 } };
  struct GNUNET_MQ_Envelope *ev;
  struct ClientStartMessage *init;
 
  GNUNET_assert (NULL == ch->mq);
  ch->mq = GNUNET_CLIENT_connect (ch->cfg,
                                  "ats",
                                  handlers,
                                  &error_handler,
                                  ch);
  if (NULL == ch->mq)
  {
    force_reconnect (ch);
    return;
  }
  ev = GNUNET_MQ_msg (init,
                      GNUNET_MESSAGE_TYPE_ATS_START);
  init->start_flag = htonl (START_FLAG_CONNECTION_SUGGESTION);
  GNUNET_MQ_send (ch->mq, ev);
  if (NULL == ch->mq)
    return;
  GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
                                         &transmit_suggestion,
                                         ch);
}

References ch, error_handler(), force_reconnect(), GNUNET_assert, GNUNET_CLIENT_connect(), GNUNET_CONTAINER_multipeermap_iterate(), GNUNET_MESSAGE_TYPE_ATS_START, GNUNET_MQ_msg, GNUNET_MQ_send(), handlers, init, GNUNET_CADET_Channel::mq, START_FLAG_CONNECTION_SUGGESTION, and transmit_suggestion().

Referenced by GNUNET_ATS_connectivity_init(), and reconnect_task().

Here is the call graph for this function:

Here is the caller graph for this function:

reconnect_task()

static void reconnect_task ( void *  cls )

static

Re-establish the connection to the ATS service.

Parameters

cls	handle to use to re-connect.

Definition at line 106 of file ats_api_connectivity.c.

{
  struct GNUNET_ATS_ConnectivityHandle *ch = cls;
 
  ch->task = NULL;
  reconnect (ch);
}

References ch, and reconnect().

Referenced by force_reconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

force_reconnect()

static void force_reconnect ( struct GNUNET_ATS_ConnectivityHandle *  ch )

static

Disconnect from ATS and then reconnect.

Parameters

ch	our handle

Definition at line 121 of file ats_api_connectivity.c.

{
  if (NULL != ch->mq)
  {
    GNUNET_MQ_destroy (ch->mq);
    ch->mq = NULL;
  }
  ch->backoff = GNUNET_TIME_STD_BACKOFF (ch->backoff);
  ch->task = GNUNET_SCHEDULER_add_delayed (ch->backoff,
                                           &reconnect_task,
                                           ch);
}

References ch, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_add_delayed(), GNUNET_TIME_STD_BACKOFF, GNUNET_CADET_Channel::mq, and reconnect_task().

Referenced by error_handler(), and reconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

error_handler()

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

static

We encountered an error handling the MQ to the ATS service.

Reconnect.

Parameters

cls	the struct GNUNET_ATS_ConnectivityHandle
error	details about the error

Definition at line 143 of file ats_api_connectivity.c.

{
  struct GNUNET_ATS_ConnectivityHandle *ch = cls;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "ATS connection died (code %d), reconnecting\n",
       (int) error);
  force_reconnect (ch);
}

References ch, force_reconnect(), GNUNET_ERROR_TYPE_DEBUG, and LOG.

Referenced by GNUNET_CLIENT_connect(), GNUNET_MQ_queue_for_callbacks(), and reconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

transmit_suggestion()

static int transmit_suggestion ( void *  cls, const struct GNUNET_PeerIdentity *  peer, void *  value  )

static

Transmit request for an address suggestion.

Parameters

cls	the struct GNUNET_ATS_ConnectivityHandle
peer	peer to ask for an address suggestion for
value	the struct GNUNET_ATS_SuggestHandle

Returns

GNUNET_OK (continue to iterate), GNUNET_SYSERR on failure (message queue no longer exists)

Definition at line 165 of file ats_api_connectivity.c.

{
  struct GNUNET_ATS_ConnectivityHandle *ch = cls;
  struct GNUNET_ATS_ConnectivitySuggestHandle *sh = value;
  struct GNUNET_MQ_Envelope *ev;
  struct RequestAddressMessage *m;
 
  if (NULL == ch->mq)
    return GNUNET_SYSERR;
  ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS);
  m->strength = htonl (sh->strength);
  m->peer = *peer;
  GNUNET_MQ_send (ch->mq, ev);
  return GNUNET_OK;
}

References ch, GNUNET_MESSAGE_TYPE_ATS_REQUEST_ADDRESS, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_OK, GNUNET_SYSERR, m, GNUNET_CADET_Channel::mq, peer, sh, and value.

Referenced by GNUNET_ATS_connectivity_suggest(), and reconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

free_sug_handle()

static int free_sug_handle ( void *  cls, const struct GNUNET_PeerIdentity *  key, void *  value  )

static

Function called to free all struct GNUNET_ATS_ConnectivitySuggestHandles in the map.

Parameters

cls	NULL
key	the key
value	the value to free

Returns

GNUNET_OK (continue to iterate)

Definition at line 250 of file ats_api_connectivity.c.

{
  struct GNUNET_ATS_ConnectivitySuggestHandle *cur = value;
 
  GNUNET_free (cur);
  return GNUNET_OK;
}

References GNUNET_free, GNUNET_OK, and value.

Referenced by GNUNET_ATS_connectivity_done().

Here is the caller graph for this function: