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 add requests
48 struct GNUNET_PEERSTORE_AddContext;
51 * Continuation called with a status result.
54 * @param emsg error message, NULL on success
56 typedef void (*GNUNET_PEERSTORE_Continuation)(void *cls, const char *emsg);
59 * Connect to the PEERSTORE service.
61 * @return NULL on error
63 struct GNUNET_PEERSTORE_Handle *
64 GNUNET_PEERSTORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
67 * Disconnect from the PEERSTORE service
69 * @param h handle to disconnect
72 GNUNET_PEERSTORE_disconnect(struct GNUNET_PEERSTORE_Handle *h);
75 * Store a new entry in the PEERSTORE
77 * @param h Handle to the PEERSTORE service
78 * @param peer Peer Identity
79 * @param sub_system name of the sub system
80 * @param value entry value BLOB
81 * @param size size of 'value'
82 * @param lifetime relative time after which the entry is (possibly) deleted
83 * @param cont Continuation function after the store request is processed
84 * @param cont_cls Closure for 'cont'
86 struct GNUNET_PEERSTORE_StoreContext *
87 GNUNET_PEERSTORE_store (struct GNUNET_PEERSTORE_Handle *h,
88 const struct GNUNET_PeerIdentity *peer,
89 const char *sub_system,
92 struct GNUNET_TIME_Relative lifetime,
93 GNUNET_PEERSTORE_Continuation cont,
97 * Cancel a store request
99 * @param sc Store request context
102 GNUNET_PEERSTORE_store_cancel (struct GNUNET_PEERSTORE_StoreContext *sc);
104 #if 0 /* keep Emacsens' auto-indent happy */