aboutsummaryrefslogtreecommitdiff
path: root/src/service/peerstore/peerstore_common.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/service/peerstore/peerstore_common.h')
-rw-r--r--src/service/peerstore/peerstore_common.h84
1 files changed, 84 insertions, 0 deletions
diff --git a/src/service/peerstore/peerstore_common.h b/src/service/peerstore/peerstore_common.h
new file mode 100644
index 000000000..b0239e66e
--- /dev/null
+++ b/src/service/peerstore/peerstore_common.h
@@ -0,0 +1,84 @@
1/*
2 This file is part of GNUnet
3 Copyright (C) 2013-2016 GNUnet e.V.
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 * @file peerstore/peerstore_common.h
23 * @brief Helper peerstore functions
24 * @author Omar Tarabai
25 */
26#include "platform.h"
27#include "peerstore.h"
28
29/**
30 * Creates a hash of the given key combination
31 *
32 */
33void
34PEERSTORE_hash_key (const char *sub_system,
35 const struct GNUNET_PeerIdentity *peer,
36 const char *key,
37 struct GNUNET_HashCode *ret);
38
39
40/**
41 * Creates a MQ envelope for a single record
42 *
43 * @param rid request ID
44 * @param sub_system sub system string
45 * @param peer Peer identity (can be NULL)
46 * @param key record key string (can be NULL)
47 * @param value record value BLOB (can be NULL)
48 * @param value_size record value size in bytes (set to 0 if value is NULL)
49 * @param expiry time after which the record expires
50 * @param options options specific to the storage operation
51 * @param msg_type message type to be set in header
52 * @return pointer to record message struct
53 */
54struct GNUNET_MQ_Envelope *
55PEERSTORE_create_record_mq_envelope (uint32_t rid,
56 const char *sub_system,
57 const struct GNUNET_PeerIdentity *peer,
58 const char *key,
59 const void *value,
60 size_t value_size,
61 struct GNUNET_TIME_Absolute expiry,
62 enum GNUNET_PEERSTORE_StoreOption options,
63 uint16_t msg_type);
64
65
66/**
67 * Parses a message carrying a record
68 *
69 * @param srm the actual message
70 * @return Pointer to record or NULL on error
71 */
72struct GNUNET_PEERSTORE_Record *
73PEERSTORE_parse_record_message (const struct PeerstoreRecordMessage *srm);
74
75
76/**
77 * Free any memory allocated for this record
78 *
79 * @param record
80 */
81void
82PEERSTORE_destroy_record (struct GNUNET_PEERSTORE_Record *record);
83
84/* end of peerstore_common.h */