fixing mess with search update serialization and parenting
[oweals/gnunet.git] / src / datastore / datastore.h
1 /*
2      This file is part of GNUnet
3      (C) 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
4
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 2, or (at your
8      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      General Public License for more details.
14
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.
19 */
20
21 /**
22  * @file datastore/datastore.h
23  * @brief structs for communication between datastore service and API
24  * @author Christian Grothoff
25  */
26
27 #ifndef DATASTORE_H
28 #define DATASTORE_H
29
30 #define DEBUG_DATASTORE GNUNET_NO
31
32 #include "gnunet_util_lib.h"
33
34 /**
35  * Message from datastore service informing client about
36  * the current size of the datastore.
37  */
38 struct ReserveMessage
39 {
40   /**
41    * Type is GNUNET_MESSAGE_TYPE_DATASTORE_RESERVE.
42    */
43   struct GNUNET_MessageHeader header;
44
45   /**
46    * Number of items to reserve.
47    */
48   uint32_t entries GNUNET_PACKED;
49
50   /**
51    * Number of bytes to reserve.
52    */
53   uint64_t amount GNUNET_PACKED;
54 };
55
56
57 /**
58  * Message from datastore service informing client about
59  * the success or failure of a requested operation.
60  * This header is optionally followed by a variable-size,
61  * 0-terminated error message.
62  */
63 struct StatusMessage
64 {
65   /**
66    * Type is GNUNET_MESSAGE_TYPE_DATASTORE_STATUS.
67    */
68   struct GNUNET_MessageHeader header;
69
70   /**
71    * Status code, -1 for errors.
72    */
73   int32_t status GNUNET_PACKED;
74
75 };
76
77
78 /**
79  * Message from datastore client informing service that
80  * the remainder of the reserved bytes can now be released
81  * for other requests.
82  */
83 struct ReleaseReserveMessage
84 {
85   /**
86    * Type is GNUNET_MESSAGE_TYPE_DATASTORE_RELEASE_RESERVE.
87    */
88   struct GNUNET_MessageHeader header;
89
90   /**
91    * Reservation id.
92    */
93   int32_t rid GNUNET_PACKED;
94
95 };
96
97
98 /**
99  * Message to the datastore service asking about specific
100  * content.
101  */
102 struct GetMessage
103 {
104   /**
105    * Type is GNUNET_MESSAGE_TYPE_DATASTORE_GET.  Size
106    * can either be "sizeof(struct GetMessage)" or 
107    * "sizeof(struct GetMessage) - sizeof(GNUNET_HashCode)"!
108    */
109   struct GNUNET_MessageHeader header;
110
111   /**
112    * Desired content type.
113    */
114   uint32_t type GNUNET_PACKED;
115
116   /**
117    * Desired key (optional).  Check the "size" of the
118    * header to see if the key is actually present.
119    */
120   GNUNET_HashCode key GNUNET_PACKED;
121
122 };
123
124
125 /**
126  * Message to the datastore service requesting an update
127  * to the priority or expiration for some content.
128  */
129 struct UpdateMessage
130 {
131   /**
132    * Type is GNUNET_MESSAGE_TYPE_DATASTORE_UPDATE.
133    */
134   struct GNUNET_MessageHeader header;
135
136   /**
137    * Desired priority increase.
138    */
139   int32_t priority GNUNET_PACKED;
140
141   /**
142    * Desired new expiration time.
143    */
144   struct GNUNET_TIME_AbsoluteNBO expiration;
145
146   /**
147    * Unique ID for the content.
148    */
149   uint64_t uid;
150
151 };
152
153
154 /**
155  * Message transmitting content from or to the datastore
156  * service.
157  */
158 struct DataMessage
159 {
160   /**
161    * Type is either GNUNET_MESSAGE_TYPE_DATASTORE_PUT,
162    * GNUNET_MESSAGE_TYPE_DATASTORE_REMOVE or
163    * GNUNET_MESSAGE_TYPE_DATASTORE_DATA.  Depending on the message
164    * type, some fields may simply have values of zero.
165    */
166   struct GNUNET_MessageHeader header;
167
168   /**
169    * Reservation ID to use; use zero for none.
170    */
171   uint32_t rid GNUNET_PACKED;
172
173   /**
174    * Number of bytes in the item (NBO).
175    */
176   uint32_t size GNUNET_PACKED;
177
178   /**
179    * Type of the item (NBO), zero for remove.
180    */
181   uint32_t type GNUNET_PACKED;
182
183   /**
184    * Priority of the item (NBO), zero for remove.
185    */
186   uint32_t priority GNUNET_PACKED;
187   
188   /**
189    * Desired anonymity level (NBO), zero for remove.
190    */
191   uint32_t anonymity GNUNET_PACKED;
192
193   /**
194    * Unique ID for the content (can be used for UPDATE);
195    * can be zero for remove (which indicates that
196    * the datastore should use whatever UID matches
197    * the key and content).
198    */
199   uint64_t uid;
200   
201   /**
202    * Expiration time (NBO); zero for remove.
203    */
204   struct GNUNET_TIME_AbsoluteNBO expiration;
205
206   /**
207    * Key under which the item can be found.
208    */
209   GNUNET_HashCode key GNUNET_PACKED;
210
211 };
212
213
214
215
216 #endif