NSE service

Network Size Estimation. More...

Collaboration diagram for NSE service:

Macros
#define	GNUNET_NSE_VERSION   0x00000000
	Version of the network size estimation API. More...
#define	GNUNET_NSE_log_estimate_to_n(loge)   pow (2.0, (loge))
	Convert the logarithmic estimated returned to the 'GNUNET_NSE_Callback' into an absolute estimate in terms of the number of peers in the network. More...

Typedefs
typedef void(*	GNUNET_NSE_Callback) (void *cls, struct GNUNET_TIME_Absolute timestamp, double logestimate, double std_dev)
	Callback to call when network size estimate is updated. More...

Functions
struct GNUNET_NSE_Handle *	GNUNET_NSE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_NSE_Callback func, void *func_cls)
	Connect to the network size estimation service. More...
void	GNUNET_NSE_disconnect (struct GNUNET_NSE_Handle *h)
	Disconnect from network size estimation service. More...

Detailed Description

Network Size Estimation.

Provides an API to retrieve the current network size estimate, also to register for notifications whenever a new network size estimate is calculated.

See also

Documentation

Macro Definition Documentation

GNUNET_NSE_VERSION

#define GNUNET_NSE_VERSION   0x00000000

Version of the network size estimation API.

Definition at line 59 of file gnunet_nse_service.h.

GNUNET_NSE_log_estimate_to_n

#define GNUNET_NSE_log_estimate_to_n

(

loge

)

pow (2.0, (loge))

Convert the logarithmic estimated returned to the 'GNUNET_NSE_Callback' into an absolute estimate in terms of the number of peers in the network.

Parameters

loge	logarithmic estimate

Returns

absolute number of peers in the network (estimated)

Definition at line 88 of file gnunet_nse_service.h.

Typedef Documentation

GNUNET_NSE_Callback

typedef void(* GNUNET_NSE_Callback) (void *cls, struct GNUNET_TIME_Absolute timestamp, double logestimate, double std_dev)

Callback to call when network size estimate is updated.

Parameters

cls	closure
timestamp	time when the estimate was received from the server (or created by the server)
logestimate	the log(Base 2) value of the current network size estimate
std_dev	standard deviation for the estimate

Definition at line 74 of file gnunet_nse_service.h.

Function Documentation

GNUNET_NSE_connect()

struct GNUNET_NSE_Handle * GNUNET_NSE_connect	(	const struct GNUNET_CONFIGURATION_Handle *	cfg,
		GNUNET_NSE_Callback	func,
		void *	func_cls
	)

Connect to the network size estimation service.

Parameters

cfg	the configuration to use
func	function to call with network size estimate
func_cls	closure to pass to func

Returns

handle to use in GNUNET_NSE_disconnect to stop NSE from invoking the callbacks

Parameters

cfg	the configuration to use
func	function to call with network size estimate
func_cls	closure to pass to func

Returns

handle to use

Definition at line 164 of file nse_api.c.

{
  struct GNUNET_NSE_Handle *h;
 
  GNUNET_assert (NULL != func);
  h = GNUNET_new (struct GNUNET_NSE_Handle);
  h->cfg = cfg;
  h->recv_cb = func;
  h->recv_cb_cls = func_cls;
  h->reconnect_delay = GNUNET_TIME_UNIT_ZERO;
  reconnect (h);
  if (NULL == h->mq)
  {
    GNUNET_free (h);
    return NULL;
  }
  return h;
}

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

Referenced by DHTU_gnunet_init(), reconnect(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_NSE_disconnect()

void GNUNET_NSE_disconnect

(

struct GNUNET_NSE_Handle *

h

)

Disconnect from network size estimation service.

Parameters

h	handle to destroy

Definition at line 192 of file nse_api.c.

{
  if (NULL != h->reconnect_task)
  {
    GNUNET_SCHEDULER_cancel (h->reconnect_task);
    h->reconnect_task = NULL;
  }
  if (NULL != h->mq)
  {
    GNUNET_MQ_destroy (h->mq);
    h->mq = NULL;
  }
  GNUNET_free (h);
}

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

Referenced by DHTU_gnunet_done(), do_shutdown(), GNUNET_RPS_disconnect(), reconnect(), and shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function: