Peer Info service

Maintain the list of currently known hosts. More...

Collaboration diagram for Peer Info service:

Typedefs
typedef void(*	GNUNET_PEERINFO_Processor) (void *cls, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_HELLO_Message *hello, const char *err_msg)
	Type of an iterator over the hosts. More...

Functions
struct GNUNET_PEERINFO_Handle *	GNUNET_PEERINFO_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Connect to the peerinfo service. More...
void	GNUNET_PEERINFO_disconnect (struct GNUNET_PEERINFO_Handle *h)
	Disconnect from the peerinfo service. More...
struct GNUNET_MQ_Envelope *	GNUNET_PEERINFO_add_peer (struct GNUNET_PEERINFO_Handle *h, const struct GNUNET_HELLO_Message *hello, GNUNET_SCHEDULER_TaskCallback cont, void *cont_cls)
	Add a host to the persistent list. More...
struct GNUNET_PEERINFO_IteratorContext *	GNUNET_PEERINFO_iterate (struct GNUNET_PEERINFO_Handle *h, int include_friend_only, const struct GNUNET_PeerIdentity *peer, GNUNET_PEERINFO_Processor callback, void *callback_cls)
	Call a method for each known matching host. More...
void	GNUNET_PEERINFO_iterate_cancel (struct GNUNET_PEERINFO_IteratorContext *ic)
	Cancel an iteration over peer information. More...
struct GNUNET_PEERINFO_NotifyContext *	GNUNET_PEERINFO_notify (const struct GNUNET_CONFIGURATION_Handle *cfg, int include_friend_only, GNUNET_PEERINFO_Processor callback, void *callback_cls)
	Call a method whenever our known information about peers changes. More...
void	GNUNET_PEERINFO_notify_cancel (struct GNUNET_PEERINFO_NotifyContext *nc)
	Stop notifying about changes. More...

Detailed Description

Maintain the list of currently known hosts.

Holds an in-memory structure of data/hosts.

See also

Documentation

Typedef Documentation

GNUNET_PEERINFO_Processor

typedef void(* GNUNET_PEERINFO_Processor) (void *cls, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_HELLO_Message *hello, const char *err_msg)

Type of an iterator over the hosts.

Note that each host will be called with each available protocol.

Parameters

cls	closure
peer	id of the peer, NULL for last call
hello	hello message for the peer (can be NULL)
error	message

Definition at line 120 of file gnunet_peerinfo_service.h.

Function Documentation

GNUNET_PEERINFO_connect()

struct GNUNET_PEERINFO_Handle* GNUNET_PEERINFO_connect

(

const struct GNUNET_CONFIGURATION_Handle *

cfg

)

Connect to the peerinfo service.

Parameters

cfg	configuration to use

Returns

NULL on error (configuration related, actual connection etablishment may happen asynchronously).

Definition at line 123 of file peerinfo_api.c.

{
  struct GNUNET_PEERINFO_Handle *h;
 
  h = GNUNET_new (struct GNUNET_PEERINFO_Handle);
  h->cfg = cfg;
  reconnect (h);
  if (NULL == h->mq)
  {
    GNUNET_free (h);
    return NULL;
  }
  return h;
}

References cfg, GNUNET_ARM_Handle::cfg, GNUNET_free, GNUNET_new, h, GNUNET_ARM_Handle::mq, and reconnect().

Referenced by GCH_init(), GNUNET_HOSTLIST_client_start(), GNUNET_HOSTLIST_server_start(), libgnunet_plugin_rest_peerinfo_init(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_PEERINFO_disconnect()

void GNUNET_PEERINFO_disconnect

(

struct GNUNET_PEERINFO_Handle *

h

)

Disconnect from the peerinfo service.

Note that all iterators must have completed or have been cancelled by the time this function is called (otherwise, calling this function is a serious error). Furthermore, if GNUNET_PEERINFO_add_peer() operations are still pending, they will be cancelled silently on disconnect.

Parameters

h	handle to disconnect

Definition at line 149 of file peerinfo_api.c.

{
  struct GNUNET_PEERINFO_IteratorContext *ic;
 
  while (NULL != (ic = h->ic_head))
  {
    GNUNET_CONTAINER_DLL_remove (h->ic_head,
                                 h->ic_tail,
                                 ic);
    GNUNET_free (ic);
  }
  if (NULL != h->mq)
  {
    GNUNET_MQ_destroy (h->mq);
    h->mq = NULL;
  }
  if (NULL != h->r_task)
  {
    GNUNET_SCHEDULER_cancel (h->r_task);
    h->r_task = NULL;
  }
  GNUNET_free (h);
}

References GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_cancel(), h, and GNUNET_ARM_Handle::mq.

Referenced by cleaning_task(), cleanup_handle(), GCH_shutdown(), GNUNET_HOSTLIST_client_stop(), GNUNET_HOSTLIST_server_stop(), libgnunet_plugin_rest_peerinfo_done(), and shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_PEERINFO_add_peer()

struct GNUNET_MQ_Envelope* GNUNET_PEERINFO_add_peer	(	struct GNUNET_PEERINFO_Handle *	h,
		const struct GNUNET_HELLO_Message *	hello,
		GNUNET_SCHEDULER_TaskCallback	cont,
		void *	cont_cls
	)

Add a host to the persistent list.

This method operates in semi-reliable mode: if the transmission is not completed by the time GNUNET_PEERINFO_disconnect() is called, it will be aborted. Furthermore, if a second HELLO is added for the same peer before the first one was transmitted, PEERINFO may merge the two HELLOs prior to transmission to the service.

Parameters

h	handle to the peerinfo service
hello	the verified (!) HELLO message
cont	continuation to call when done, NULL is allowed
cont_cls	closure for cont

Returns

handle to cancel add operation; all pending 'add' operations will be cancelled automatically on disconnect, so it is not necessary to keep this handle (unless cont is non-NULL and at some point calling cont must be prevented)

This method operates in semi-reliable mode: if the transmission is not completed by the time GNUNET_PEERINFO_disconnect() is called, it will be aborted. Furthermore, if a second HELLO is added for the same peer before the first one was transmitted, PEERINFO may merge the two HELLOs prior to transmission to the service.

Parameters

h	handle to the peerinfo service
hello	the verified (!) HELLO message
cont	continuation to call when done, NULL is allowed
cont_cls	closure for cont

Returns

handle to cancel add operation; all pending 'add' operations will be cancelled automatically on disconnect, so it is not necessary to keep this handle (unless cont is NULL and at some point calling cont must be prevented)

Definition at line 530 of file peerinfo_api.c.

{
  struct GNUNET_MQ_Envelope *env;
  struct GNUNET_PeerIdentity peer;
 
  if (NULL == h->mq)
    return NULL;
  GNUNET_assert (GNUNET_OK ==
                 GNUNET_HELLO_get_id (hello,
                                      &peer));
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Adding peer `%s' to PEERINFO database\n",
       GNUNET_i2s (&peer));
  env = GNUNET_MQ_msg_copy ((const struct GNUNET_MessageHeader *) hello);
  if (NULL != cont)
    GNUNET_MQ_notify_sent (env,
                           cont,
                           cont_cls);
  GNUNET_MQ_send (h->mq,
                  env);
  return env;
}

References env, GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_HELLO_get_id(), GNUNET_i2s(), GNUNET_MQ_msg_copy(), GNUNET_MQ_notify_sent(), GNUNET_MQ_send(), GNUNET_OK, h, LOG, GNUNET_ARM_Handle::mq, and peer.

Referenced by callback_download(), GST_validation_handle_pong(), handle_hello(), parse_hello_uri(), and refresh_hello_task().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_PEERINFO_iterate()

struct GNUNET_PEERINFO_IteratorContext* GNUNET_PEERINFO_iterate	(	struct GNUNET_PEERINFO_Handle *	h,
		int	include_friend_only,
		const struct GNUNET_PeerIdentity *	peer,
		GNUNET_PEERINFO_Processor	callback,
		void *	callback_cls
	)

Call a method for each known matching host.

The callback method will be invoked once for each matching host and then finally once with a NULL pointer. After that final invocation, the iterator context must no longer be used.

Instead of calling this function with peer == NULL it is often better to use GNUNET_PEERINFO_notify().

Parameters

h	handle to the peerinfo service
include_friend_only	include HELLO messages for friends only
peer	restrict iteration to this peer only (can be NULL)
callback	the method to call for each peer
callback_cls	closure for callback

Returns

iterator context

Definition at line 464 of file peerinfo_api.c.

{
  struct GNUNET_PEERINFO_IteratorContext *ic;
 
  ic = GNUNET_new (struct GNUNET_PEERINFO_IteratorContext);
  ic->h = h;
  ic->include_friend_only = include_friend_only;
  ic->callback = callback;
  ic->callback_cls = callback_cls;
  if (NULL != peer)
  {
    ic->have_peer = GNUNET_YES;
    ic->peer = *peer;
  }
  GNUNET_CONTAINER_DLL_insert_tail (h->ic_head,
                                    h->ic_tail,
                                    ic);
  if (h->ic_head == ic)
    send_ic_request (h);
  return ic;
}

References GNUNET_PEERINFO_IteratorContext::callback, GNUNET_PEERINFO_IteratorContext::callback_cls, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_new, GNUNET_YES, h, GNUNET_PEERINFO_IteratorContext::h, GNUNET_PEERINFO_IteratorContext::have_peer, include_friend_only, GNUNET_PEERINFO_IteratorContext::include_friend_only, GNUNET_PEERINFO_IteratorContext::peer, peer, and send_ic_request().

Referenced by peerinfo_get(), process_notify(), and state_machine().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_PEERINFO_iterate_cancel()

void GNUNET_PEERINFO_iterate_cancel

(

struct GNUNET_PEERINFO_IteratorContext *

ic

)

Cancel an iteration over peer information.

Parameters

ic	context of the iterator to cancel

Definition at line 497 of file peerinfo_api.c.

{
  struct GNUNET_PEERINFO_Handle *h = ic->h;
 
  ic->callback = NULL;
  if (ic == h->ic_head)
    return;
  GNUNET_CONTAINER_DLL_remove (h->ic_head,
                               h->ic_tail,
                               ic);
  GNUNET_free (ic);
}

References GNUNET_PEERINFO_IteratorContext::callback, GNUNET_CONTAINER_DLL_remove, GNUNET_free, h, and GNUNET_PEERINFO_IteratorContext::h.

Referenced by cleanup_handle(), GNUNET_HOSTLIST_server_stop(), process_notify(), and shutdown_task().

Here is the caller graph for this function:

GNUNET_PEERINFO_notify()

struct GNUNET_PEERINFO_NotifyContext* GNUNET_PEERINFO_notify	(	const struct GNUNET_CONFIGURATION_Handle *	cfg,
		int	include_friend_only,
		GNUNET_PEERINFO_Processor	callback,
		void *	callback_cls
	)

Call a method whenever our known information about peers changes.

Initially calls the given function for all known peers and then only signals changes.

If include_friend_only is set to GNUNET_YES peerinfo will include HELLO messages which are intended for friend to friend mode and which do not have to be gossiped. Otherwise these messages are skipped.

Parameters

cfg	configuration to use
include_friend_only	include HELLO messages for friends only
callback	the method to call for each peer
callback_cls	closure for callback

Returns

NULL on error

Definition at line 245 of file peerinfo_api_notify.c.

{
  struct GNUNET_PEERINFO_NotifyContext *nc;
 
  nc = GNUNET_new (struct GNUNET_PEERINFO_NotifyContext);
  nc->cfg = cfg;
  nc->callback = callback;
  nc->callback_cls = callback_cls;
  nc->include_friend_only = include_friend_only;
  reconnect (nc);
  if (NULL == nc->mq)
  {
    LOG (GNUNET_ERROR_TYPE_WARNING,
         "Could not connect to PEERINFO service.\n");
    GNUNET_free (nc);
    return NULL;
  }
  return nc;
}

References GNUNET_PEERINFO_NotifyContext::callback, GNUNET_PEERINFO_NotifyContext::callback_cls, cfg, GNUNET_PEERINFO_NotifyContext::cfg, GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_new, include_friend_only, GNUNET_PEERINFO_NotifyContext::include_friend_only, LOG, GNUNET_PEERINFO_NotifyContext::mq, nc, and reconnect().

Referenced by core_init(), core_init_cb(), GCH_init(), GNUNET_HOSTLIST_server_start(), GST_validation_start(), process_peer(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_PEERINFO_notify_cancel()

void GNUNET_PEERINFO_notify_cancel

(

struct GNUNET_PEERINFO_NotifyContext *

nc

)

Stop notifying about changes.

Parameters

nc	context to stop notifying

Definition at line 275 of file peerinfo_api_notify.c.

{
  if (NULL != nc->mq)
  {
    GNUNET_MQ_destroy (nc->mq);
    nc->mq = NULL;
  }
  if (NULL != nc->task)
  {
    GNUNET_SCHEDULER_cancel (nc->task);
    nc->task = NULL;
  }
  GNUNET_free (nc);
}

References GNUNET_free, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_cancel(), GNUNET_PEERINFO_NotifyContext::mq, nc, and GNUNET_PEERINFO_NotifyContext::task.

Referenced by cleaning_task(), GCH_shutdown(), GNUNET_HOSTLIST_server_stop(), GST_validation_stop(), libgnunet_plugin_dhtu_gnunet_done(), process_peer(), and shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function: