src/datacache/plugin_datacache_template.c

   1 /*
   2      This file is part of GNUnet
   3      (C) 2006, 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file datacache/plugin_datacache_template.c
  23  * @brief template for an implementation of a database backend for the datacache
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_datacache_plugin.h"
  29
  30
  31 /**
  32  * Context for all functions in this plugin.
  33  */
  34 struct Plugin
  35 {
  36   /**
  37    * Our execution environment.
  38    */
  39   struct GNUNET_DATACACHE_PluginEnvironment *env;
  40 };
  41
  42
  43 /**
  44  * Store an item in the datastore.
  45  *
  46  * @param cls closure (our "struct Plugin")
  47  * @param key key to store data under
  48  * @param size number of bytes in data
  49  * @param data data to store
  50  * @param type type of the value
  51  * @param discard_time when to discard the value in any case
  52  * @param path_info_len number of entries in 'path_info'
  53  * @param path_info a path through the network
  54  * @return 0 if duplicate, -1 on error, number of bytes used otherwise
  55  */
  56 static ssize_t
  57 template_plugin_put (void *cls, const struct GNUNET_HashCode * key, size_t size,
  58                      const char *data, enum GNUNET_BLOCK_Type type,
  59                      struct GNUNET_TIME_Absolute discard_time,
  60                      unsigned int path_info_len,
  61                      const struct GNUNET_PeerIdentity *path_info)
  62 {
  63   GNUNET_break (0);
  64   return -1;
  65 }
  66
  67
  68 /**
  69  * Iterate over the results for a particular key
  70  * in the datastore.
  71  *
  72  * @param cls closure (our "struct Plugin")
  73  * @param key
  74  * @param type entries of which type are relevant?
  75  * @param iter maybe NULL (to just count)
  76  * @param iter_cls closure for iter
  77  * @return the number of results found
  78  */
  79 static unsigned int
  80 template_plugin_get (void *cls, const struct GNUNET_HashCode * key,
  81                      enum GNUNET_BLOCK_Type type,
  82                      GNUNET_DATACACHE_Iterator iter, void *iter_cls)
  83 {
  84   GNUNET_break (0);
  85   return 0;
  86 }
  87
  88
  89 /**
  90  * Delete the entry with the lowest expiration value
  91  * from the datacache right now.
  92  *
  93  * @param cls closure (our "struct Plugin")
  94  * @return GNUNET_OK on success, GNUNET_SYSERR on error
  95  */
  96 static int
  97 template_plugin_del (void *cls)
  98 {
  99   GNUNET_break (0);
 100   return GNUNET_SYSERR;
 101 }
 102
 103
 104 /**
 105  * Entry point for the plugin.
 106  *
 107  * @param cls closure (the "struct GNUNET_DATACACHE_PluginEnvironmnet")
 108  * @return the plugin's closure (our "struct Plugin")
 109  */
 110 void *
 111 libgnunet_plugin_datacache_template_init (void *cls)
 112 {
 113   struct GNUNET_DATACACHE_PluginEnvironment *env = cls;
 114   struct GNUNET_DATACACHE_PluginFunctions *api;
 115   struct Plugin *plugin;
 116
 117   plugin = GNUNET_malloc (sizeof (struct Plugin));
 118   plugin->env = env;
 119   api = GNUNET_malloc (sizeof (struct GNUNET_DATACACHE_PluginFunctions));
 120   api->cls = plugin;
 121   api->get = &template_plugin_get;
 122   api->put = &template_plugin_put;
 123   api->del = &template_plugin_del;
 124   GNUNET_log_from (GNUNET_ERROR_TYPE_INFO, "template",
 125                    _("Template datacache running\n"));
 126   return api;
 127 }
 128
 129
 130 /**
 131  * Exit point from the plugin.
 132  *
 133  * @param cls closure (our "struct Plugin")
 134  * @return NULL
 135  */
 136 void *
 137 libgnunet_plugin_datacache_template_done (void *cls)
 138 {
 139   struct GNUNET_DATACACHE_PluginFunctions *api = cls;
 140   struct Plugin *plugin = api->cls;
 141
 142   GNUNET_free (plugin);
 143   GNUNET_free (api);
 144   return NULL;
 145 }
 146
 147
 148
 149 /* end of plugin_datacache_template.c */