/*
This file is part of GNUnet
- (C)
+ Copyright (C) GNUnet e.V. 2004--2019
- GNUnet is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ GNUnet is free software: you can redistribute it and/or modify it
+ under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License,
+ or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
+ Affero General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+ SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
- * @file include/gnunet_peerstore_service.h
- * @brief API to the peerstore service
* @author Omar Tarabai
+ *
+ * @file
+ * API to the peerstore service
+ *
+ * @defgroup peerstore Peer Store service
+ *
+ * @see [Documentation](https://gnunet.org/gnunets-peerstore-subsystem)
+ *
+ * @{
*/
#ifndef GNUNET_PEERSTORE_SERVICE_H
#define GNUNET_PEERSTORE_SERVICE_H
-#include "platform.h"
#include "gnunet_util_lib.h"
#ifdef __cplusplus
-extern "C"
-{
-#if 0 /* keep Emacsens' auto-indent happy */
+extern "C" {
+#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
+
+/**
+ * Key used for storing addresses in URL format in the peerstore
+ */
+#define GNUNET_PEERSTORE_TRANSPORT_URLADDRESS_KEY "transport-communicator-url"
+
+/**
+ * Key used for storing HELLOs in the peerstore
+ */
+#define GNUNET_PEERSTORE_TRANSPORT_HELLO_KEY "transport-peer-hello"
+
+/**
+ * Key used to store sender's monotonic time from backchannel
+ * messages.
+ */
+#define GNUNET_PEERSTORE_TRANSPORT_BACKCHANNEL_MONOTIME \
+ "transport-backchannel-monotonic-time"
+
+/**
+ * Key used to store sender's monotonic time from DV learn
+ * messages.
+ */
+#define GNUNET_PEERSTORE_TRANSPORT_DVLEARN_MONOTIME \
+ "transport-dv-learn-monotonic-time"
+
+
/**
* Options for storing values in PEERSTORE
*/
enum GNUNET_PEERSTORE_StoreOption
{
-
/**
* Possibly store multiple values under given key.
*/
* storing the given value.
*/
GNUNET_PEERSTORE_STOREOPTION_REPLACE = 1
-
};
/**
*/
struct GNUNET_PEERSTORE_Record
{
-
/**
* Responsible sub system string
*/
/**
* Peer Identity
*/
- struct GNUNET_PeerIdentity *peer;
+ struct GNUNET_PeerIdentity peer;
/**
* Record key string
/**
* Expiry time of entry
*/
- struct GNUNET_TIME_Absolute *expiry;
+ struct GNUNET_TIME_Absolute expiry;
/**
- * Client from which this record originated
+ * Client from which this record originated.
+ * NOTE: This is internal to the service.
*/
- struct GNUNET_SERVER_Client *client;
+ struct GNUNET_SERVICE_Client *client;
};
* @param cls closure
* @param success #GNUNET_OK or #GNUNET_SYSERR
*/
-typedef void
-(*GNUNET_PEERSTORE_Continuation)(void *cls, int success);
+typedef void (*GNUNET_PEERSTORE_Continuation) (void *cls, int success);
+
/**
* Function called by PEERSTORE for each matching record.
* @param cls closure
* @param record peerstore record information
* @param emsg error message, or NULL if no errors
- * @return #GNUNET_YES to continue iterating, #GNUNET_NO to stop
*/
-typedef int
-(*GNUNET_PEERSTORE_Processor) (void *cls,
- const struct GNUNET_PEERSTORE_Record *record,
- const char *emsg);
+typedef void (*GNUNET_PEERSTORE_Processor) (
+ void *cls,
+ const struct GNUNET_PEERSTORE_Record *record,
+ const char *emsg);
+
/**
* Connect to the PEERSTORE service.
* @param sync_first send any pending STORE requests before disconnecting
*/
void
-GNUNET_PEERSTORE_disconnect (struct GNUNET_PEERSTORE_Handle *h,
- int sync_first);
+GNUNET_PEERSTORE_disconnect (struct GNUNET_PEERSTORE_Handle *h, int sync_first);
/**
* @param sub_system name of sub system
* @param peer Peer identity (can be NULL)
* @param key entry key string (can be NULL)
- * @param timeout time after which the iterate request is canceled
* @param callback function called with each matching record, all NULL's on end
* @param callback_cls closure for @a callback
*/
const char *sub_system,
const struct GNUNET_PeerIdentity *peer,
const char *key,
- struct GNUNET_TIME_Relative timeout,
GNUNET_PEERSTORE_Processor callback,
void *callback_cls);
void
GNUNET_PEERSTORE_watch_cancel (struct GNUNET_PEERSTORE_WatchContext *wc);
-#if 0 /* keep Emacsens' auto-indent happy */
+
+#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
#endif
#endif
+
+/** @} */ /* end of group */
projects / oweals / gnunet.git / blobdiff