src/include/gnunet_peerstore_service.h

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