src: for every AGPL3.0 file, add SPDX identifier.
[oweals/gnunet.git] / src / peerstore / peerstore.h
1 /*
2       This file is part of GNUnet
3       Copyright (C) 2012-2013 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  * @file peerstore/peerstore.h
22  * @brief IPC messages
23  * @author Omar Tarabai
24  */
25
26 #ifndef PEERSTORE_H_
27 #define PEERSTORE_H_
28
29 #include "gnunet_peerstore_service.h"
30
31
32 GNUNET_NETWORK_STRUCT_BEGIN
33 /**
34  * Message carrying a PEERSTORE record message
35  */
36 struct StoreRecordMessage
37 {
38
39   /**
40    * GNUnet message header
41    */
42   struct GNUNET_MessageHeader header;
43
44   /**
45    * #GNUNET_YES if peer id value set, #GNUNET_NO otherwise
46    */
47   uint16_t peer_set GNUNET_PACKED;
48
49   /**
50    * Size of the sub_system string
51    * Allocated at position 0 after this struct
52    */
53   uint16_t sub_system_size GNUNET_PACKED;
54
55   /**
56    * Peer Identity
57    */
58   struct GNUNET_PeerIdentity peer;
59
60   /**
61    * Expiry time of entry
62    */
63   struct GNUNET_TIME_AbsoluteNBO expiry;
64
65   /**
66    * Size of the key string
67    * Allocated at position 1 after this struct
68    */
69   uint16_t key_size GNUNET_PACKED;
70
71   /**
72    * Size of value blob
73    * Allocated at position 2 after this struct
74    */
75   uint16_t value_size GNUNET_PACKED;
76
77   /**
78    * Options, needed only in case of a
79    * store operation
80    */
81   uint32_t /* enum GNUNET_PEERSTORE_StoreOption */ options GNUNET_PACKED;
82
83   /* Followed by key and value */
84
85 };
86
87
88 /**
89  * Message carrying record key hash
90  */
91 struct StoreKeyHashMessage
92 {
93
94   /**
95    * GNUnet message header
96    */
97   struct GNUNET_MessageHeader header;
98
99   /**
100    * Always 0, for alignment.
101    */
102   uint32_t reserved GNUNET_PACKED;
103
104   /**
105    * Hash of a record key
106    */
107   struct GNUNET_HashCode keyhash;
108
109 };
110
111 GNUNET_NETWORK_STRUCT_END
112 #endif