transport_api_application.c File Reference

#include "platform.h"
#include "gnunet_transport_application_service.h"
#include "gnunet_transport_core_service.h"
#include "transport.h"

Include dependency graph for transport_api_application.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_TRANSPORT_ApplicationSuggestHandle
	Handle for TRANSPORT address suggestion requests. More...
struct	GNUNET_TRANSPORT_ApplicationHandle
	Handle to the TRANSPORT subsystem for application management. More...

Macros
#define	LOG(kind, ...)    GNUNET_log_from (kind, "transport-application-api", __VA_ARGS__)

Functions
static void	reconnect (struct GNUNET_TRANSPORT_ApplicationHandle *ch)
	Re-establish the connection to the TRANSPORT service.
static void	reconnect_task (void *cls)
	Re-establish the connection to the TRANSPORT service.
static void	force_reconnect (struct GNUNET_TRANSPORT_ApplicationHandle *ch)
	Disconnect from TRANSPORT and then reconnect.
static void	error_handler (void *cls, enum GNUNET_MQ_Error error)
	We encountered an error handling the MQ to the TRANSPORT service.
static int	transmit_suggestion (void *cls, const struct GNUNET_PeerIdentity *peer, void *value)
	Transmit request for an address suggestion.
struct GNUNET_TRANSPORT_ApplicationHandle *	GNUNET_TRANSPORT_application_init (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Initialize the TRANSPORT application suggestion client handle.
static int	free_sug_handle (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
	Function called to free all struct GNUNET_TRANSPORT_ApplicationSuggestHandles in the map.
void	GNUNET_TRANSPORT_application_done (struct GNUNET_TRANSPORT_ApplicationHandle *ch)
	Client is done with TRANSPORT application management, release resources.
struct GNUNET_TRANSPORT_ApplicationSuggestHandle *	GNUNET_TRANSPORT_application_suggest (struct GNUNET_TRANSPORT_ApplicationHandle *ch, const struct GNUNET_PeerIdentity *peer, enum GNUNET_MQ_PriorityPreferences pk, struct GNUNET_BANDWIDTH_Value32NBO bw)
	An application would like TRANSPORT to connect to a peer.
void	GNUNET_TRANSPORT_application_suggest_cancel (struct GNUNET_TRANSPORT_ApplicationSuggestHandle *sh)
	We no longer care about being connected to a peer.
void	GNUNET_TRANSPORT_application_validate (struct GNUNET_TRANSPORT_ApplicationHandle *ch, const struct GNUNET_PeerIdentity *peer, enum GNUNET_NetworkType nt, const char *addr)
	An application (or a communicator) has received a HELLO (or other address data of another peer) and wants TRANSPORT to validate that the address is correct.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log_from (kind, "transport-application-api", __VA_ARGS__)

Definition at line 32 of file transport_api_application.c.

{
  struct GNUNET_PeerIdentity id;
 
  struct GNUNET_TRANSPORT_ApplicationHandle *ch;
 
  enum GNUNET_MQ_PriorityPreferences pk;
 
  struct GNUNET_BANDWIDTH_Value32NBO bw;
};
 
 
struct GNUNET_TRANSPORT_ApplicationHandle
{
  const struct GNUNET_CONFIGURATION_Handle *cfg;
 
  struct GNUNET_CONTAINER_MultiPeerMap *sug_requests;
 
  struct GNUNET_MQ_Handle *mq;
 
  struct GNUNET_SCHEDULER_Task *task;
 
  struct GNUNET_TIME_Relative backoff;
};
 
 
static void
reconnect (struct GNUNET_TRANSPORT_ApplicationHandle *ch);
 
 
static void
reconnect_task (void *cls)
{
  struct GNUNET_TRANSPORT_ApplicationHandle *ch = cls;
 
  ch->task = NULL;
  reconnect (ch);
}
 
 
static void
force_reconnect (struct GNUNET_TRANSPORT_ApplicationHandle *ch)
{
  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);
}
 
 
static void
error_handler (void *cls, enum GNUNET_MQ_Error error)
{
  struct GNUNET_TRANSPORT_ApplicationHandle *ch = cls;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "TRANSPORT connection died (code %d), reconnecting\n",
       (int) error);
  force_reconnect (ch);
}
 
 
static int
transmit_suggestion (void *cls,
                     const struct GNUNET_PeerIdentity *peer,
                     void *value)
{
  struct GNUNET_TRANSPORT_ApplicationHandle *ch = cls;
  struct GNUNET_TRANSPORT_ApplicationSuggestHandle *sh = value;
  struct GNUNET_MQ_Envelope *ev;
  struct ExpressPreferenceMessage *m;
 
  if (NULL == ch->mq)
    return GNUNET_SYSERR;
  ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_TRANSPORT_SUGGEST);
  m->pk = htonl ((uint32_t) sh->pk);
  m->bw = sh->bw;
  m->peer = *peer;
  GNUNET_MQ_send (ch->mq, ev);
  return GNUNET_OK;
}
 
 
static void
reconnect (struct GNUNET_TRANSPORT_ApplicationHandle *ch)
{
  static const struct GNUNET_MQ_MessageHandler handlers[] = { { NULL, 0, 0 } };
 
  GNUNET_assert (NULL == ch->mq);
  ch->mq =
    GNUNET_CLIENT_connect (ch->cfg, "transport", handlers, &error_handler, ch);
  if (NULL == ch->mq)
  {
    force_reconnect (ch);
    return;
  }
  GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
                                         &transmit_suggestion,
                                         ch);
}
 
 
struct GNUNET_TRANSPORT_ApplicationHandle *
GNUNET_TRANSPORT_application_init (
  const struct GNUNET_CONFIGURATION_Handle *cfg)
{
  struct GNUNET_TRANSPORT_ApplicationHandle *ch;
 
  ch = GNUNET_new (struct GNUNET_TRANSPORT_ApplicationHandle);
  ch->cfg = cfg;
  ch->sug_requests = GNUNET_CONTAINER_multipeermap_create (32, GNUNET_YES);
  reconnect (ch);
  return ch;
}
 
 
static int
free_sug_handle (void *cls, const struct GNUNET_PeerIdentity *key, void *value)
{
  struct GNUNET_TRANSPORT_ApplicationSuggestHandle *cur = value;
 
  GNUNET_free (cur);
  return GNUNET_OK;
}
 
 
void
GNUNET_TRANSPORT_application_done (
  struct GNUNET_TRANSPORT_ApplicationHandle *ch)
{
  if (NULL != ch->mq)
  {
    GNUNET_MQ_destroy (ch->mq);
    ch->mq = NULL;
  }
  if (NULL != ch->task)
  {
    GNUNET_SCHEDULER_cancel (ch->task);
    ch->task = NULL;
  }
  GNUNET_CONTAINER_multipeermap_iterate (ch->sug_requests,
                                         &free_sug_handle,
                                         NULL);
  GNUNET_CONTAINER_multipeermap_destroy (ch->sug_requests);
  GNUNET_free (ch);
}
 
 
struct GNUNET_TRANSPORT_ApplicationSuggestHandle *
GNUNET_TRANSPORT_application_suggest (
  struct GNUNET_TRANSPORT_ApplicationHandle *ch,
  const struct GNUNET_PeerIdentity *peer,
  enum GNUNET_MQ_PriorityPreferences pk,
  struct GNUNET_BANDWIDTH_Value32NBO bw)
{
  struct GNUNET_TRANSPORT_ApplicationSuggestHandle *s;
 
  s = GNUNET_new (struct GNUNET_TRANSPORT_ApplicationSuggestHandle);
  s->ch = ch;
  s->id = *peer;
  s->pk = pk;
  s->bw = bw;
  (void) GNUNET_CONTAINER_multipeermap_put (
    ch->sug_requests,
    &s->id,
    s,
    GNUNET_CONTAINER_MULTIHASHMAPOPTION_MULTIPLE);
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Requesting TRANSPORT to suggest address for `%s'\n",
       GNUNET_i2s (peer));
  if (NULL == ch->mq)
    return s;
  GNUNET_assert (GNUNET_OK == transmit_suggestion (ch, &s->id, s));
  return s;
}
 
 
void
GNUNET_TRANSPORT_application_suggest_cancel (
  struct GNUNET_TRANSPORT_ApplicationSuggestHandle *sh)
{
  struct GNUNET_TRANSPORT_ApplicationHandle *ch = sh->ch;
  struct GNUNET_MQ_Envelope *ev;
  struct ExpressPreferenceMessage *m;
 
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Telling TRANSPORT we no longer care for an address for `%s'\n",
       GNUNET_i2s (&sh->id));
  GNUNET_assert (
    GNUNET_OK ==
    GNUNET_CONTAINER_multipeermap_remove (ch->sug_requests, &sh->id, sh));
  if (NULL == ch->mq)
  {
    GNUNET_free (sh);
    return;
  }
  ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_TRANSPORT_SUGGEST_CANCEL);
  m->pk = htonl ((uint32_t) sh->pk);
  m->bw = sh->bw;
  m->peer = sh->id;
  GNUNET_MQ_send (ch->mq, ev);
  GNUNET_free (sh);
}
 
 
void
GNUNET_TRANSPORT_application_validate (
  struct GNUNET_TRANSPORT_ApplicationHandle *ch,
  const struct GNUNET_PeerIdentity *peer,
  enum GNUNET_NetworkType nt,
  const char *addr)
{
  struct GNUNET_MQ_Envelope *ev;
  struct RequestHelloValidationMessage *m;
  size_t alen;
 
  if (NULL == ch->mq)
  {
    GNUNET_log (
      GNUNET_ERROR_TYPE_WARNING,
      "Address validation for %s:%s skipped as transport is not connected\n",
      GNUNET_i2s (peer),
      addr);
    return;
  }
  alen = strlen (addr) + 1;
  ev =
    GNUNET_MQ_msg_extra (m,
                         alen,
                         GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_HELLO_VALIDATION);
  m->peer = *peer;
  m->nt = htonl ((uint32_t) nt);
  memcpy (&m[1], addr, alen);
  GNUNET_MQ_send (ch->mq, ev);
}
 
 
/* end of transport_api2_application.c */

Function Documentation

reconnect()

static void reconnect ( struct GNUNET_TRANSPORT_ApplicationHandle *  ch )

static

Re-establish the connection to the TRANSPORT service.

Parameters

ch	handle to use to re-connect.

Definition at line 194 of file transport_api_application.c.

{
  static const struct GNUNET_MQ_MessageHandler handlers[] = { { NULL, 0, 0 } };
 
  GNUNET_assert (NULL == ch->mq);
  ch->mq =
    GNUNET_CLIENT_connect (ch->cfg, "transport", handlers, &error_handler, ch);
  if (NULL == ch->mq)
  {
    force_reconnect (ch);
    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(), handlers, GNUNET_CADET_Channel::mq, and transmit_suggestion().

Here is the call graph for this function:

reconnect_task()

static void reconnect_task ( void *  cls )

static

Re-establish the connection to the TRANSPORT service.

Parameters

cls	handle to use to re-connect.

Definition at line 112 of file transport_api_application.c.

{
  struct GNUNET_TRANSPORT_ApplicationHandle *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_TRANSPORT_ApplicationHandle *  ch )

static

Disconnect from TRANSPORT and then reconnect.

Parameters

ch	our handle

Definition at line 127 of file transport_api_application.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 TRANSPORT service.

Reconnect.

Parameters

cls	the struct GNUNET_TRANSPORT_ApplicationHandle
error	details about the error

Definition at line 147 of file transport_api_application.c.

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

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

Referenced by 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_TRANSPORT_ApplicationHandle
peer	peer to ask for an address suggestion for
value	the struct GNUNET_TRANSPORT_SuggestHandle

Returns

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

Definition at line 168 of file transport_api_application.c.

{
  struct GNUNET_TRANSPORT_ApplicationHandle *ch = cls;
  struct GNUNET_TRANSPORT_ApplicationSuggestHandle *sh = value;
  struct GNUNET_MQ_Envelope *ev;
  struct ExpressPreferenceMessage *m;
 
  if (NULL == ch->mq)
    return GNUNET_SYSERR;
  ev = GNUNET_MQ_msg (m, GNUNET_MESSAGE_TYPE_TRANSPORT_SUGGEST);
  m->pk = htonl ((uint32_t) sh->pk);
  m->bw = sh->bw;
  m->peer = *peer;
  GNUNET_MQ_send (ch->mq, ev);
  return GNUNET_OK;
}

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

Referenced by GNUNET_TRANSPORT_application_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_TRANSPORT_ApplicationSuggestHandles in the map.

Parameters

cls	NULL
key	the key
value	the value to free

Returns

GNUNET_OK (continue to iterate)

Definition at line 242 of file transport_api_application.c.

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

References GNUNET_free, GNUNET_OK, and value.

Referenced by GNUNET_TRANSPORT_application_done().

Here is the caller graph for this function: