1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/*
This file is part of GNUnet
(C)
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 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.
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.
*/
/**
* @file peerstore/peerstore_common.h
* @brief Helper peerstore functions
* @author Omar Tarabai
*/
#include "peerstore.h"
/**
* Creates a hash of the given key combination
*
*/
void
PEERSTORE_hash_key (const char *sub_system,
const struct GNUNET_PeerIdentity *peer, const char *key,
struct GNUNET_HashCode *ret);
/**
* Creates a record message ready to be sent
*
* @param sub_system sub system string
* @param peer Peer identity (can be NULL)
* @param key record key string (can be NULL)
* @param value record value BLOB (can be NULL)
* @param value_size record value size in bytes (set to 0 if value is NULL)
* @param expiry absolute time after which the record expires
* @param msg_type message type to be set in header
* @return pointer to record message struct
*/
struct StoreRecordMessage *
PEERSTORE_create_record_message (const char *sub_system,
const struct GNUNET_PeerIdentity *peer,
const char *key, const void *value,
size_t value_size,
struct GNUNET_TIME_Absolute *expiry,
uint16_t msg_type);
/**
* Creates a MQ envelope for a single record
*
* @param sub_system sub system string
* @param peer Peer identity (can be NULL)
* @param key record key string (can be NULL)
* @param value record value BLOB (can be NULL)
* @param value_size record value size in bytes (set to 0 if value is NULL)
* @param expiry time after which the record expires
* @param options options specific to the storage operation
* @param msg_type message type to be set in header
* @return pointer to record message struct
*/
struct GNUNET_MQ_Envelope *
PEERSTORE_create_record_mq_envelope (const char *sub_system,
const struct GNUNET_PeerIdentity *peer,
const char *key, const void *value,
size_t value_size,
struct GNUNET_TIME_Absolute *expiry,
enum GNUNET_PEERSTORE_StoreOption options,
uint16_t msg_type);
/**
* Parses a message carrying a record
*
* @param message the actual message
* @return Pointer to record or NULL if error
*/
struct GNUNET_PEERSTORE_Record *
PEERSTORE_parse_record_message (const struct GNUNET_MessageHeader *message);
/**
* Free any memory allocated for this record
*
* @param record
*/
void
PEERSTORE_destroy_record (struct GNUNET_PEERSTORE_Record *record);
|
