gnunet-service-transport_hello.h File Reference

hello API More...

#include "gnunet_statistics_service.h"
#include "gnunet_transport_service.h"
#include "gnunet_util_lib.h"
#include "gnunet_hello_lib.h"

Include dependency graph for gnunet-service-transport_hello.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef void(*	GST_HelloCallback) (void *cls, const struct GNUNET_MessageHeader *hello)
	Signature of a function to call whenever our hello changes. More...

Functions
void	GST_hello_start (int friend_only, GST_HelloCallback cb, void *cb_cls)
	Initialize the HELLO module. More...
void	GST_hello_stop (void)
	Shutdown the HELLO module. More...
const struct GNUNET_MessageHeader *	GST_hello_get (void)
	Obtain this peers HELLO message. More...
void	GST_hello_modify_addresses (int addremove, const struct GNUNET_HELLO_Address *address)
	Add or remove an address from this peer's HELLO message. More...
int	GST_hello_test_address (const struct GNUNET_HELLO_Address *address, struct GNUNET_CRYPTO_EddsaSignature **sig, struct GNUNET_TIME_Absolute **sig_expiration)
	Test if a particular address is one of ours. More...

Detailed Description

hello API

Author

Christian Grothoff

Definition in file gnunet-service-transport_hello.h.

Typedef Documentation

GST_HelloCallback

typedef void(* GST_HelloCallback) (void *cls, const struct GNUNET_MessageHeader *hello)

Signature of a function to call whenever our hello changes.

Parameters

cls	closure
hello	updated HELLO

Definition at line 40 of file gnunet-service-transport_hello.h.

Function Documentation

GST_hello_start()

void GST_hello_start	(	int	friend_only,
		GST_HelloCallback	cb,
		void *	cb_cls
	)

Initialize the HELLO module.

Parameters

friend_only	use a friend only hello
cb	function to call whenever our HELLO changes
cb_cls	closure for cb

Definition at line 237 of file gnunet-service-transport_hello.c.

{
  hello_cb = cb;
  hello_cb_cls = cb_cls;
  friend_option = friend_only;
  refresh_hello_task (NULL);
}

References friend_option, hello_cb, hello_cb_cls, and refresh_hello_task().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

GST_hello_stop()

void GST_hello_stop

(

void

)

Shutdown the HELLO module.

Definition at line 252 of file gnunet-service-transport_hello.c.

{
  hello_cb = NULL;
  hello_cb_cls = NULL;
  if (NULL != hello_task)
  {
    GNUNET_SCHEDULER_cancel (hello_task);
    hello_task = NULL;
  }
  if (NULL != our_hello)
  {
    GNUNET_free (our_hello);
    our_hello = NULL;
  }
}

References GNUNET_free, GNUNET_SCHEDULER_cancel(), hello_cb, hello_cb_cls, hello_task, and our_hello.

Referenced by shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function:

GST_hello_get()

const struct GNUNET_MessageHeader* GST_hello_get

(

void

)

Obtain this peers HELLO message.

Returns

our HELLO message

Definition at line 275 of file gnunet-service-transport_hello.c.

{
  return (const struct GNUNET_MessageHeader *) our_hello;
}

References our_hello.

Referenced by GST_plugins_load(), handle_client_start(), refresh_hello_task(), and transmit_ping_if_allowed().

Here is the caller graph for this function:

GST_hello_modify_addresses()

void GST_hello_modify_addresses	(	int	addremove,
		const struct GNUNET_HELLO_Address *	address
	)

Add or remove an address from this peer's HELLO message.

Parameters

addremove	GNUNET_YES to add, GNUNET_NO to remove
address	address to add or remove

Definition at line 288 of file gnunet-service-transport_hello.c.

{
  struct OwnAddressList *al;
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              (GNUNET_YES == addremove)
              ? "Adding `%s' to the set of our addresses\n"
              : "Removing `%s' from the set of our addresses\n",
              GST_plugins_a2s (address));
  GNUNET_assert (NULL != address);
  for (al = oal_head; al != NULL; al = al->next)
    if (0 == GNUNET_HELLO_address_cmp (address, al->address))
      break;
  if (GNUNET_NO == addremove)
  {
    if (NULL == al)
    {
      /* address to be removed not found!? */
      GNUNET_break (0);
      return;
    }
    al->rc--;
    if (0 != al->rc)
      return;   /* RC not yet zero */
    GNUNET_CONTAINER_DLL_remove (oal_head,
                                 oal_tail,
                                 al);
    GNUNET_HELLO_address_free (al->address);
    GNUNET_free (al);
    refresh_hello ();
    return;
  }
  if (NULL != al)
  {
    /* address added twice or more */
    al->rc++;
    return;
  }
  al = GNUNET_new (struct OwnAddressList);
  al->rc = 1;
  GNUNET_CONTAINER_DLL_insert (oal_head,
                               oal_tail,
                               al);
  al->address = GNUNET_HELLO_address_copy (address);
  refresh_hello ();
}

References address, OwnAddressList::address, GNUNET_assert, GNUNET_break, GNUNET_CONTAINER_DLL_insert, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_HELLO_address_cmp(), GNUNET_HELLO_address_copy(), GNUNET_HELLO_address_free, GNUNET_log, GNUNET_new, GNUNET_NO, GNUNET_YES, GST_plugins_a2s(), OwnAddressList::next, oal_head, oal_tail, OwnAddressList::rc, and refresh_hello().

Referenced by plugin_env_address_change_notification().

Here is the call graph for this function:

Here is the caller graph for this function:

GST_hello_test_address()

int GST_hello_test_address	(	const struct GNUNET_HELLO_Address *	address,
		struct GNUNET_CRYPTO_EddsaSignature **	sig,
		struct GNUNET_TIME_Absolute **	sig_expiration
	)

Test if a particular address is one of ours.

Parameters

address	the address to test
sig	location where to cache PONG signatures for this address [set]
sig_expiration	how long until the current 'sig' expires? (ZERO if sig was never created) [set]

Returns

GNUNET_YES if this is one of our addresses, GNUNET_NO if not

Definition at line 338 of file gnunet-service-transport_hello.c.

{
  struct OwnAddressList *al;
 
  for (al = oal_head; al != NULL; al = al->next)
    if (0 == GNUNET_HELLO_address_cmp (address,
                                       al->address))
    {
      *sig = &al->pong_signature;
      *sig_expiration = &al->pong_sig_expires;
      return GNUNET_YES;
    }
  *sig = NULL;
  *sig_expiration = NULL;
  return GNUNET_NO;
}

References address, OwnAddressList::address, GNUNET_HELLO_address_cmp(), GNUNET_NO, GNUNET_YES, OwnAddressList::next, oal_head, OwnAddressList::pong_sig_expires, and OwnAddressList::pong_signature.

Referenced by GST_validation_handle_ping().

Here is the call graph for this function:

Here is the caller graph for this function: