plugin_datacache_template.c File Reference

template for an implementation of a database backend for the datacache More...

#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_datacache_plugin.h"

Include dependency graph for plugin_datacache_template.c:

Go to the source code of this file.

Data Structures
struct	Plugin
	Handle for a plugin. More...

Functions
static ssize_t	template_plugin_put (void *cls, uint32_t xor_distance, const struct GNUNET_DATACACHE_Block *block)
	Store an item in the datastore. More...
static unsigned int	template_plugin_get (void *cls, const struct GNUNET_HashCode *key, enum GNUNET_BLOCK_Type type, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
	Iterate over the results for a particular key in the datastore. More...
static enum GNUNET_GenericReturnValue	template_plugin_del (void *cls)
	Delete the entry with the lowest expiration value from the datacache right now. More...
static unsigned int	template_plugin_get_closest (void *cls, const struct GNUNET_HashCode *key, enum GNUNET_BLOCK_Type type, unsigned int num_results, GNUNET_DATACACHE_Iterator iter, void *iter_cls)
	Iterate over the results that are "close" to a particular key in the datacache. More...
void *	libgnunet_plugin_datacache_template_init (void *cls)
	Entry point for the plugin. More...
void *	libgnunet_plugin_datacache_template_done (void *cls)
	Exit point from the plugin. More...

Detailed Description

template for an implementation of a database backend for the datacache

Author

Christian Grothoff

Definition in file plugin_datacache_template.c.

Function Documentation

template_plugin_put()

static ssize_t template_plugin_put ( void *  cls, uint32_t  xor_distance, const struct GNUNET_DATACACHE_Block *  block  )

static

Store an item in the datastore.

Parameters

cls	closure (our struct Plugin)
xor_distance	distance of key to our PID
block	data to store

Returns

0 if duplicate, -1 on error, number of bytes used otherwise

Definition at line 52 of file plugin_datacache_template.c.

{
  GNUNET_break (0);
  return -1;
}

References GNUNET_break.

Referenced by libgnunet_plugin_datacache_template_init().

Here is the caller graph for this function:

template_plugin_get()

static unsigned int template_plugin_get ( void *  cls, const struct GNUNET_HashCode *  key, enum GNUNET_BLOCK_Type  type, GNUNET_DATACACHE_Iterator  iter, void *  iter_cls  )

static

Iterate over the results for a particular key in the datastore.

Parameters

cls	closure (our struct Plugin)
key
type	entries of which type are relevant?
iter	maybe NULL (to just count)
iter_cls	closure for iter

Returns

the number of results found

Definition at line 73 of file plugin_datacache_template.c.

{
  GNUNET_break (0);
  return 0;
}

References GNUNET_break.

Referenced by libgnunet_plugin_datacache_template_init().

Here is the caller graph for this function:

template_plugin_del()

static enum GNUNET_GenericReturnValue template_plugin_del ( void *  cls )

static

Delete the entry with the lowest expiration value from the datacache right now.

Parameters

cls	closure (our struct Plugin)

Returns

GNUNET_OK on success, GNUNET_SYSERR on error

Definition at line 92 of file plugin_datacache_template.c.

{
  GNUNET_break (0);
  return GNUNET_SYSERR;
}

References GNUNET_break, and GNUNET_SYSERR.

Referenced by libgnunet_plugin_datacache_template_init().

Here is the caller graph for this function:

template_plugin_get_closest()

static unsigned int template_plugin_get_closest ( void *  cls, const struct GNUNET_HashCode *  key, enum GNUNET_BLOCK_Type  type, unsigned int  num_results, GNUNET_DATACACHE_Iterator  iter, void *  iter_cls  )

static

Iterate over the results that are "close" to a particular key in the datacache.

"close" is defined as numerically larger than key (when interpreted as a circular address space), with small distance.

Parameters

cls	closure (internal context for the plugin)
key	area of the keyspace to look into
type	desired block type for the replies
num_results	number of results that should be returned to iter
iter	maybe NULL (to just count)
iter_cls	closure for iter

Returns

the number of results found

Definition at line 114 of file plugin_datacache_template.c.

{
  GNUNET_break (0);
  return 0;
}

References GNUNET_break.

Referenced by libgnunet_plugin_datacache_template_init().

Here is the caller graph for this function:

libgnunet_plugin_datacache_template_init()

void * libgnunet_plugin_datacache_template_init

(

void *

cls

)

Entry point for the plugin.

Parameters

cls	closure (the struct GNUNET_DATACACHE_PluginEnvironmnet)

Returns

the plugin's closure (our struct Plugin)

Definition at line 133 of file plugin_datacache_template.c.

{
  struct GNUNET_DATACACHE_PluginEnvironment *env = cls;
  struct GNUNET_DATACACHE_PluginFunctions *api;
  struct Plugin *plugin;
 
  plugin = GNUNET_new (struct Plugin);
  plugin->env = env;
  api = GNUNET_new (struct GNUNET_DATACACHE_PluginFunctions);
  api->cls = plugin;
  api->get = &template_plugin_get;
  api->put = &template_plugin_put;
  api->del = &template_plugin_del;
  api->get_closest = &template_plugin_get_closest;
  GNUNET_log_from (GNUNET_ERROR_TYPE_INFO,
                   "template",
                   "Template datacache running\n");
  return api;
}

References Plugin::api, GNUNET_BLOCK_PluginFunctions::cls, GNUNET_DATACACHE_PluginEnvironment::cls, env, GNUNET_ERROR_TYPE_INFO, GNUNET_log_from, GNUNET_new, plugin, template_plugin_del(), template_plugin_get(), template_plugin_get_closest(), and template_plugin_put().

Here is the call graph for this function:

libgnunet_plugin_datacache_template_done()

void * libgnunet_plugin_datacache_template_done

(

void *

cls

)

Exit point from the plugin.

Parameters

cls	closure (our struct Plugin)

Returns

NULL

Definition at line 161 of file plugin_datacache_template.c.

{
  struct GNUNET_DATACACHE_PluginFunctions *api = cls;
  struct Plugin *plugin = api->cls;
 
  GNUNET_free (plugin);
  GNUNET_free (api);
  return NULL;
}

References Plugin::api, GNUNET_BLOCK_PluginFunctions::cls, GNUNET_DATACACHE_PluginFunctions::cls, GNUNET_free, and plugin.