Name Cache service

Store naming information on a GNUnet node. More...

Collaboration diagram for Name Cache service:

Macros
#define	GNUNET_NAMECACHE_MAX_VALUE_SIZE   (63 * 1024)
	Maximum size of a value that can be stored in the namecache. More...

Typedefs
typedef void(*	GNUNET_NAMECACHE_ContinuationWithStatus) (void *cls, int32_t success, const char *emsg)
	Continuation called to notify client about result of the operation. More...
typedef void(*	GNUNET_NAMECACHE_BlockProcessor) (void *cls, const struct GNUNET_GNSRECORD_Block *block)
	Process a record that was stored in the namecache. More...

Functions
struct GNUNET_NAMECACHE_Handle *	GNUNET_NAMECACHE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Connect to the namecache service. More...
void	GNUNET_NAMECACHE_disconnect (struct GNUNET_NAMECACHE_Handle *h)
	Disconnect from the namecache service (and free associated resources). More...
struct GNUNET_NAMECACHE_QueueEntry *	GNUNET_NAMECACHE_block_cache (struct GNUNET_NAMECACHE_Handle *h, const struct GNUNET_GNSRECORD_Block *block, GNUNET_NAMECACHE_ContinuationWithStatus cont, void *cont_cls)
	Store an item in the namecache. More...
struct GNUNET_NAMECACHE_QueueEntry *	GNUNET_NAMECACHE_lookup_block (struct GNUNET_NAMECACHE_Handle *h, const struct GNUNET_HashCode *derived_hash, GNUNET_NAMECACHE_BlockProcessor proc, void *proc_cls)
	Get a result for a particular key from the namecache. More...
void	GNUNET_NAMECACHE_cancel (struct GNUNET_NAMECACHE_QueueEntry *qe)
	Cancel a namecache operation. More...

Detailed Description

Store naming information on a GNUnet node.

Naming information can either be records for which this peer/user is authoritative, or blocks which are cached, encrypted naming data from other peers.

See also

Documentation

Macro Definition Documentation

GNUNET_NAMECACHE_MAX_VALUE_SIZE

#define GNUNET_NAMECACHE_MAX_VALUE_SIZE   (63 * 1024)

Maximum size of a value that can be stored in the namecache.

Definition at line 71 of file gnunet_namecache_service.h.

Typedef Documentation

GNUNET_NAMECACHE_ContinuationWithStatus

typedef void(* GNUNET_NAMECACHE_ContinuationWithStatus) (void *cls, int32_t success, const char *emsg)

Continuation called to notify client about result of the operation.

Parameters

cls	closure
success	GNUNET_SYSERR on failure (including timeout/queue drop/failure to validate) GNUNET_NO if content was already there or not found GNUNET_YES (or other positive value) on success
emsg	NULL on success, otherwise an error message

Definition at line 105 of file gnunet_namecache_service.h.

GNUNET_NAMECACHE_BlockProcessor

typedef void(* GNUNET_NAMECACHE_BlockProcessor) (void *cls, const struct GNUNET_GNSRECORD_Block *block)

Process a record that was stored in the namecache.

Parameters

cls	closure
block	block that was stored in the namecache

Definition at line 134 of file gnunet_namecache_service.h.

Function Documentation

GNUNET_NAMECACHE_connect()

struct GNUNET_NAMECACHE_Handle * GNUNET_NAMECACHE_connect

(

const struct GNUNET_CONFIGURATION_Handle *

cfg

)

Connect to the namecache service.

Parameters

cfg	configuration to use

Returns

handle to use to access the service

Connect to the namecache service.

Parameters

cfg	configuration to use

Returns

handle to the GNS service, or NULL on error

Definition at line 403 of file namecache_api.c.

{
  struct GNUNET_NAMECACHE_Handle *h;
 
  h = GNUNET_new (struct GNUNET_NAMECACHE_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 run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_NAMECACHE_disconnect()

void GNUNET_NAMECACHE_disconnect

(

struct GNUNET_NAMECACHE_Handle *

h

)

Disconnect from the namecache service (and free associated resources).

Must not be called from within operation callbacks of the API.

Parameters

h	handle to the namecache
h	handle to the namecache

Definition at line 426 of file namecache_api.c.

{
  struct GNUNET_NAMECACHE_QueueEntry *q;
 
  GNUNET_break (NULL == h->op_head);
  while (NULL != (q = h->op_head))
  {
    GNUNET_CONTAINER_DLL_remove (h->op_head,
                                 h->op_tail,
                                 q);
    GNUNET_free (q);
  }
  if (NULL != h->mq)
  {
    GNUNET_MQ_destroy (h->mq);
    h->mq = NULL;
  }
  if (NULL != h->reconnect_task)
  {
    GNUNET_SCHEDULER_cancel (h->reconnect_task);
    h->reconnect_task = NULL;
  }
  GNUNET_free (h);
}

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

Referenced by do_shutdown(), and shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_NAMECACHE_block_cache()

struct GNUNET_NAMECACHE_QueueEntry * GNUNET_NAMECACHE_block_cache	(	struct GNUNET_NAMECACHE_Handle *	h,
		const struct GNUNET_GNSRECORD_Block *	block,
		GNUNET_NAMECACHE_ContinuationWithStatus	cont,
		void *	cont_cls
	)

Store an item in the namecache.

If the item is already present, it is replaced with the new record.

Parameters

h	handle to the namecache
block	block to store
cont	continuation to call when done
cont_cls	closure for cont

Returns

handle to abort the request, NULL on error

Definition at line 463 of file namecache_api.c.

{
  struct GNUNET_NAMECACHE_QueueEntry *qe;
  struct BlockCacheMessage *msg;
  struct GNUNET_MQ_Envelope *env;
  uint32_t rid;
  size_t blen;
 
  if (NULL == h->mq)
    return NULL;
  blen = GNUNET_GNSRECORD_block_get_size (block);
  rid = get_op_id (h);
  qe = GNUNET_new (struct GNUNET_NAMECACHE_QueueEntry);
  qe->nsh = h;
  qe->cont = cont;
  qe->cont_cls = cont_cls;
  qe->op_id = rid;
  GNUNET_CONTAINER_DLL_insert_tail (h->op_head,
                                    h->op_tail,
                                    qe);
  /* send msg */
  env = GNUNET_MQ_msg_extra (msg,
                             blen,
                             GNUNET_MESSAGE_TYPE_NAMECACHE_BLOCK_CACHE);
  msg->gns_header.r_id = htonl (rid);
  GNUNET_memcpy (&msg[1],
                 block,
                 blen);
  GNUNET_MQ_send (h->mq,
                  env);
  return qe;
}

References GNUNET_DATASTORE_QueueEntry::cont, GNUNET_DATASTORE_QueueEntry::cont_cls, env, get_op_id(), GNUNET_CONTAINER_DLL_insert_tail, GNUNET_GNSRECORD_block_get_size(), GNUNET_memcpy, GNUNET_MESSAGE_TYPE_NAMECACHE_BLOCK_CACHE, GNUNET_MQ_msg_extra, GNUNET_MQ_send(), GNUNET_new, h, GNUNET_ARM_Handle::mq, msg, and qe.

Referenced by handle_dht_response(), and refresh_block().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_NAMECACHE_lookup_block()

struct GNUNET_NAMECACHE_QueueEntry * GNUNET_NAMECACHE_lookup_block	(	struct GNUNET_NAMECACHE_Handle *	h,
		const struct GNUNET_HashCode *	derived_hash,
		GNUNET_NAMECACHE_BlockProcessor	proc,
		void *	proc_cls
	)

Get a result for a particular key from the namecache.

The processor will only be called once.

Parameters

h	handle to the namecache
derived_hash	hash of zone key combined with name to lookup then at the end once with NULL
proc	function to call on the matching block, or with NULL if there is no matching block
proc_cls	closure for proc

Returns

a handle that can be used to cancel, NULL on error

The processor will only be called once.

Parameters

h	handle to the namecache
derived_hash	hash of zone key combined with name to lookup
proc	function to call on the matching block, or with NULL if there is no matching block
proc_cls	closure for proc

Returns

a handle that can be used to cancel, NULL on error

Definition at line 512 of file namecache_api.c.

{
  struct GNUNET_NAMECACHE_QueueEntry *qe;
  struct LookupBlockMessage *msg;
  struct GNUNET_MQ_Envelope *env;
  uint32_t rid;
 
  if (NULL == h->mq)
    return NULL;
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "Looking for block under %s\n",
       GNUNET_h2s (derived_hash));
  rid = get_op_id (h);
  qe = GNUNET_new (struct GNUNET_NAMECACHE_QueueEntry);
  qe->nsh = h;
  qe->block_proc = proc;
  qe->block_proc_cls = proc_cls;
  qe->op_id = rid;
  GNUNET_CONTAINER_DLL_insert_tail (h->op_head,
                                    h->op_tail,
                                    qe);
  env = GNUNET_MQ_msg (msg,
                       GNUNET_MESSAGE_TYPE_NAMECACHE_LOOKUP_BLOCK);
  msg->gns_header.r_id = htonl (rid);
  msg->query = *derived_hash;
  GNUNET_MQ_send (h->mq,
                  env);
  return qe;
}

References env, get_op_id(), GNUNET_CONTAINER_DLL_insert_tail, GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_MESSAGE_TYPE_NAMECACHE_LOOKUP_BLOCK, GNUNET_MQ_msg, GNUNET_MQ_send(), GNUNET_new, h, LOG, GNUNET_ARM_Handle::mq, msg, and qe.

Referenced by recursive_gns_resolution_namecache(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_NAMECACHE_cancel()

void GNUNET_NAMECACHE_cancel

(

struct GNUNET_NAMECACHE_QueueEntry *

qe

)

Cancel a namecache operation.

The final callback from the operation must not have been done yet. Must be called on any namecache operation that has not yet completed prior to calling GNUNET_NAMECACHE_disconnect.

Parameters

qe	operation to cancel

The final callback from the operation must not have been done yet.

Parameters

qe	operation to cancel

Definition at line 553 of file namecache_api.c.

{
  struct GNUNET_NAMECACHE_Handle *h = qe->nsh;
 
  GNUNET_CONTAINER_DLL_remove (h->op_head,
                               h->op_tail,
                               qe);
  GNUNET_free (qe);
}

References GNUNET_CONTAINER_DLL_remove, GNUNET_free, h, and qe.

Referenced by do_shutdown(), GNS_resolver_done(), GNS_resolver_lookup_cancel(), and shutdown_task().

Here is the caller graph for this function: