src/include/gnunet_peerstore_service.h

   1 /*
   2       This file is part of GNUnet
   3       (C)
   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 include/gnunet_peerstore_service.h
  23  * @brief API to the peerstore service
  24  * @author Omar Tarabai
  25  */
  26 #ifndef GNUNET_PEERSTORE_SERVICE_H
  27 #define GNUNET_PEERSTORE_SERVICE_H
  28
  29 #include "platform.h"
  30 #include "gnunet_util_lib.h"
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #if 0                           /* keep Emacsens' auto-indent happy */
  36 }
  37 #endif
  38 #endif
  39
  40 /**
  41  * Options for storing values in PEERSTORE
  42  */
  43 enum GNUNET_PEERSTORE_StoreOption
  44 {
  45
  46   /**
  47    * Possibly store multiple values under given key.
  48    */
  49   GNUNET_PEERSTORE_STOREOPTION_MULTIPLE = 0,
  50
  51   /**
  52    * Delete any previous values for the given key before
  53    * storing the given value.
  54    */
  55   GNUNET_PEERSTORE_STOREOPTION_REPLACE = 1,
  56
  57 };
  58
  59 /**
  60  * Handle to the peerstore service.
  61  */
  62 struct GNUNET_PEERSTORE_Handle;
  63
  64 /**
  65  * Context for a store request
  66  */
  67 struct GNUNET_PEERSTORE_StoreContext;
  68
  69 /**
  70  * Single PEERSTORE record
  71  */
  72 struct GNUNET_PEERSTORE_Record
  73 {
  74
  75   /**
  76    * Responsible sub system string
  77    */
  78   char *sub_system;
  79
  80   /**
  81    * Peer Identity
  82    */
  83   struct GNUNET_PeerIdentity *peer;
  84
  85   /**
  86    * Record key string
  87    */
  88   char *key;
  89
  90   /**
  91    * Record value BLOB
  92    */
  93   void *value;
  94
  95   /**
  96    * Size of 'value' BLOB
  97    */
  98   size_t value_size;
  99
 100   /**
 101    * Expiry time of entry
 102    */
 103   struct GNUNET_TIME_Absolute *expiry;
 104
 105   /**
 106    * Client from which this record originated
 107    */
 108   struct GNUNET_SERVER_Client *client;
 109 };
 110
 111 /**
 112  * Continuation called with a status result.
 113  *
 114  * @param cls closure
 115  * @param success #GNUNET_OK or #GNUNET_SYSERR
 116  */
 117 typedef void (*GNUNET_PEERSTORE_Continuation)(void *cls, int success);
 118
 119 /**
 120  * Function called by PEERSTORE for each matching record.
 121  *
 122  * @param cls closure
 123  * @param record peerstore record information
 124  * @param emsg error message, or NULL if no errors
 125  * @return #GNUNET_YES to continue iterating, #GNUNET_NO to stop
 126  */
 127 typedef int (*GNUNET_PEERSTORE_Processor) (void *cls,
 128     struct GNUNET_PEERSTORE_Record *record,
 129     char *emsg);
 130
 131 /**
 132  * Connect to the PEERSTORE service.
 133  *
 134  * @return NULL on error
 135  */
 136 struct GNUNET_PEERSTORE_Handle *
 137 GNUNET_PEERSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 138
 139 /**
 140  * Disconnect from the PEERSTORE service. Any pending ITERATE and WATCH requests
 141  * will be canceled.
 142  * Any pending STORE requests will depend on @e snyc_first flag.
 143  *
 144  * @param h handle to disconnect
 145  * @param sync_first send any pending STORE requests before disconnecting
 146  */
 147 void
 148 GNUNET_PEERSTORE_disconnect (struct GNUNET_PEERSTORE_Handle *h, int sync_first);
 149
 150 /**
 151  * Store a new entry in the PEERSTORE.
 152  * Note that stored entries can be lost in some cases
 153  * such as power failure.
 154  *
 155  * @param h Handle to the PEERSTORE service
 156  * @param sub_system name of the sub system
 157  * @param peer Peer Identity
 158  * @param key entry key
 159  * @param value entry value BLOB
 160  * @param size size of @e value
 161  * @param expiry absolute time after which the entry is (possibly) deleted
 162  * @param options options specific to the storage operation
 163  * @param cont Continuation function after the store request is sent
 164  * @param cont_cls Closure for 'cont'
 165  */
 166 struct GNUNET_PEERSTORE_StoreContext *
 167 GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h,
 168                         const char *sub_system,
 169                         const struct GNUNET_PeerIdentity *peer,
 170                         const char *key,
 171                         const void *value,
 172                         size_t size,
 173                         struct GNUNET_TIME_Absolute expiry,
 174                         enum GNUNET_PEERSTORE_StoreOption options,
 175                         GNUNET_PEERSTORE_Continuation cont,
 176                         void *cont_cls);
 177
 178 /**
 179  * Cancel a store request
 180  *
 181  * @param sc Store request context
 182  */
 183 void
 184 GNUNET_PEERSTORE_store_cancel (struct GNUNET_PEERSTORE_StoreContext *sc);
 185
 186 /**
 187  * Iterate over records matching supplied key information
 188  *
 189  * @param h handle to the PEERSTORE service
 190  * @param sub_system name of sub system
 191  * @param peer Peer identity (can be NULL)
 192  * @param key entry key string (can be NULL)
 193  * @param timeout time after which the iterate request is canceled
 194  * @param callback function called with each matching record, all NULL's on end
 195  * @param callback_cls closure for @a callback
 196  */
 197 struct GNUNET_PEERSTORE_IterateContext *
 198 GNUNET_PEERSTORE_iterate (struct GNUNET_PEERSTORE_Handle *h,
 199     const char *sub_system,
 200     const struct GNUNET_PeerIdentity *peer,
 201     const char *key,
 202     struct GNUNET_TIME_Relative timeout,
 203     GNUNET_PEERSTORE_Processor callback, void *callback_cls);
 204
 205 /**
 206  * Cancel an iterate request
 207  * Please do not call after the iterate request is done
 208  *
 209  * @param ic Iterate request context as returned by GNUNET_PEERSTORE_iterate()
 210  */
 211 void
 212 GNUNET_PEERSTORE_iterate_cancel (struct GNUNET_PEERSTORE_IterateContext *ic);
 213
 214 /**
 215  * Request watching a given key
 216  * User will be notified with any new values added to key
 217  *
 218  * @param h handle to the PEERSTORE service
 219  * @param sub_system name of sub system
 220  * @param peer Peer identity
 221  * @param key entry key string
 222  * @param callback function called with each new value
 223  * @param callback_cls closure for @a callback
 224  * @return Handle to watch request
 225  */
 226 struct GNUNET_PEERSTORE_WatchContext *
 227 GNUNET_PEERSTORE_watch (struct GNUNET_PEERSTORE_Handle *h,
 228     const char *sub_system,
 229     const struct GNUNET_PeerIdentity *peer,
 230     const char *key,
 231     GNUNET_PEERSTORE_Processor callback, void *callback_cls);
 232
 233 /**
 234  * Cancel a watch request
 235  *
 236  * @param wc handle to the watch request
 237  */
 238 void
 239 GNUNET_PEERSTORE_watch_cancel(struct GNUNET_PEERSTORE_WatchContext *wc);
 240
 241 #if 0                           /* keep Emacsens' auto-indent happy */
 242 {
 243 #endif
 244 #ifdef __cplusplus
 245 }
 246 #endif
 247
 248 #endif