2 This file is part of GNUnet
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.
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.
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.
22 * @file include/gnunet_peerstore_service.h
23 * @brief API to the peerstore service
24 * @author Omar Tarabai
26 #ifndef GNUNET_PEERSTORE_SERVICE_H
27 #define GNUNET_PEERSTORE_SERVICE_H
30 #include "gnunet_util_lib.h"
35 #if 0 /* keep Emacsens' auto-indent happy */
41 * Handle to the peerstore service.
43 struct GNUNET_PEERSTORE_Handle;
46 * Context for a store request
48 struct GNUNET_PEERSTORE_StoreContext;
51 * Single PEERSTORE record
53 struct GNUNET_PEERSTORE_Record
57 * Responsible sub system string
64 struct GNUNET_PeerIdentity *peer;
77 * Size of 'value' BLOB
82 * Expiry time of entry
84 struct GNUNET_TIME_Absolute *expiry;
89 * Continuation called with a status result.
92 * @param success #GNUNET_OK or #GNUNET_SYSERR
94 typedef void (*GNUNET_PEERSTORE_Continuation)(void *cls, int success);
97 * Function called by for each matching record.
100 * @param record peerstore record information
101 * @param emsg error message, or NULL if no errors
102 * @return #GNUNET_YES to continue iterating, #GNUNET_NO to stop
104 typedef int (*GNUNET_PEERSTORE_Processor) (void *cls,
105 struct GNUNET_PEERSTORE_Record *record,
109 * Connect to the PEERSTORE service.
111 * @return NULL on error
113 struct GNUNET_PEERSTORE_Handle *
114 GNUNET_PEERSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
117 * Disconnect from the PEERSTORE service
119 * @param h handle to disconnect
122 GNUNET_PEERSTORE_disconnect(struct GNUNET_PEERSTORE_Handle *h);
125 * Store a new entry in the PEERSTORE
127 * @param h Handle to the PEERSTORE service
128 * @param sub_system name of the sub system
129 * @param peer Peer Identity
130 * @param key entry key
131 * @param value entry value BLOB
132 * @param size size of 'value'
133 * @param lifetime relative time after which the entry is (possibly) deleted
134 * @param cont Continuation function after the store request is processed
135 * @param cont_cls Closure for 'cont'
137 struct GNUNET_PEERSTORE_StoreContext *
138 GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h,
139 const char *sub_system,
140 const struct GNUNET_PeerIdentity *peer,
144 struct GNUNET_TIME_Absolute expiry,
145 GNUNET_PEERSTORE_Continuation cont,
149 * Cancel a store request
151 * @param sc Store request context
154 GNUNET_PEERSTORE_store_cancel (struct GNUNET_PEERSTORE_StoreContext *sc);
157 * Iterate over records matching supplied key information
159 * @param h handle to the PEERSTORE service
160 * @param sub_system name of sub system
161 * @param peer Peer identity (can be NULL)
162 * @param key entry key string (can be NULL)
163 * @param timeout time after which the iterate request is canceled
164 * @param callback function called with each matching record, all NULL's on end
165 * @param callback_cls closure for @a callback
167 struct GNUNET_PEERSTORE_IterateContext *
168 GNUNET_PEERSTORE_iterate (struct GNUNET_PEERSTORE_Handle *h,
170 const struct GNUNET_PeerIdentity *peer,
172 struct GNUNET_TIME_Relative timeout,
173 GNUNET_PEERSTORE_Processor callback, void *callback_cls);
176 * Cancel an iterate request
177 * Please do not call after the iterate request is done
179 * @param ic Iterate request context as returned by GNUNET_PEERSTORE_iterate()
182 GNUNET_PEERSTORE_iterate_cancel (struct GNUNET_PEERSTORE_IterateContext *ic);
184 #if 0 /* keep Emacsens' auto-indent happy */