2 This file is part of GNUnet.
3 Copyright (C) 2012-2014 GNUnet e.V.
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 3, or (at your
8 option) any later version.
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.
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., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @brief messages used for the set api
23 * @author Florian Dold
24 * @author Christian Grothoff
30 #include "gnunet_common.h"
31 #include "gnunet_set_service.h"
33 GNUNET_NETWORK_STRUCT_BEGIN
36 * Message sent by the client to the service to ask starting
37 * a new set to perform operations with. Includes the desired
40 struct GNUNET_SET_CreateMessage
43 * Type: #GNUNET_MESSAGE_TYPE_SET_CREATE
45 struct GNUNET_MessageHeader header;
48 * Operation type, values of `enum GNUNET_SET_OperationType`
50 uint32_t operation GNUNET_PACKED;
55 * Message sent by the client to the service to start listening for
56 * incoming requests to perform a certain type of set operation for a
57 * certain type of application.
59 struct GNUNET_SET_ListenMessage
62 * Type: #GNUNET_MESSAGE_TYPE_SET_LISTEN
64 struct GNUNET_MessageHeader header;
67 * Operation type, values of `enum GNUNET_SET_OperationType`
69 uint32_t operation GNUNET_PACKED;
74 struct GNUNET_HashCode app_id;
80 * Message sent by a listening client to the service to accept
81 * performing the operation with the other peer.
83 struct GNUNET_SET_AcceptMessage
86 * Type: #GNUNET_MESSAGE_TYPE_SET_ACCEPT
88 struct GNUNET_MessageHeader header;
91 * ID of the incoming request we want to accept.
93 uint32_t accept_reject_id GNUNET_PACKED;
96 * Request ID to identify responses.
98 uint32_t request_id GNUNET_PACKED;
101 * How should results be sent to us?
102 * See `enum GNUNET_SET_ResultMode`.
104 uint32_t result_mode GNUNET_PACKED;
109 * Message sent by a listening client to the service to reject
110 * performing the operation with the other peer.
112 struct GNUNET_SET_RejectMessage
115 * Type: #GNUNET_MESSAGE_TYPE_SET_REJECT
117 struct GNUNET_MessageHeader header;
120 * ID of the incoming request we want to reject.
122 uint32_t accept_reject_id GNUNET_PACKED;
128 * A request for an operation with another client.
130 struct GNUNET_SET_RequestMessage
133 * Type: #GNUNET_MESSAGE_TYPE_SET_REQUEST.
135 struct GNUNET_MessageHeader header;
138 * ID of the to identify the request when accepting or
141 uint32_t accept_id GNUNET_PACKED;
144 * Identity of the requesting peer.
146 struct GNUNET_PeerIdentity peer_id;
148 /* rest: context message, that is, application-specific
149 message to convince listener to pick up */
154 * Message sent by client to service to initiate a set operation as a
155 * client (not as listener). A set (which determines the operation
156 * type) must already exist in association with this client.
158 struct GNUNET_SET_EvaluateMessage
161 * Type: #GNUNET_MESSAGE_TYPE_SET_EVALUATE
163 struct GNUNET_MessageHeader header;
166 * How should results be sent to us?
167 * See `enum GNUNET_SET_ResultMode`.
169 uint32_t result_mode GNUNET_PACKED;
172 * Peer to evaluate the operation with
174 struct GNUNET_PeerIdentity target_peer;
179 struct GNUNET_HashCode app_id;
182 * Id of our set to evaluate, chosen implicitly by the client when it
183 * calls #GNUNET_SET_commit().
185 uint32_t request_id GNUNET_PACKED;
187 /* rest: context message, that is, application-specific
188 message to convince listener to pick up */
193 * Message sent by the service to the client to indicate an
194 * element that is removed (set intersection) or added
195 * (set union) or part of the final result, depending on
196 * options specified for the operation.
198 struct GNUNET_SET_ResultMessage
201 * Type: #GNUNET_MESSAGE_TYPE_SET_RESULT
203 struct GNUNET_MessageHeader header;
206 * id the result belongs to
208 uint32_t request_id GNUNET_PACKED;
211 * Was the evaluation successful? Contains
212 * an `enum GNUNET_SET_Status` in NBO.
214 uint16_t result_status GNUNET_PACKED;
217 * Type of the element attachted to the message, if any.
219 uint16_t element_type GNUNET_PACKED;
221 /* rest: the actual element */
226 * Message sent by client to the service to add or remove
227 * an element to/from the set.
229 struct GNUNET_SET_ElementMessage
232 * Type: #GNUNET_MESSAGE_TYPE_SET_ADD or
233 * #GNUNET_MESSAGE_TYPE_SET_REMOVE
235 struct GNUNET_MessageHeader header;
238 * Type of the element to add or remove.
240 uint16_t element_type GNUNET_PACKED;
243 * For alignment, always zero.
245 uint16_t reserved GNUNET_PACKED;
247 /* rest: the actual element */
252 * Sent to the service by the client
253 * in order to cancel a set operation.
255 struct GNUNET_SET_CancelMessage
258 * Type: #GNUNET_MESSAGE_TYPE_SET_CANCEL
260 struct GNUNET_MessageHeader header;
263 * ID of the request we want to cancel.
265 uint32_t request_id GNUNET_PACKED;
270 * Set element transmitted by service to client in response to a set
273 struct GNUNET_SET_IterResponseMessage
276 * Type: #GNUNET_MESSAGE_TYPE_SET_ITER_ELEMENT
278 struct GNUNET_MessageHeader header;
281 * To which set iteration does this reponse belong to? First
282 * iteration (per client) has counter zero. Wraps around.
284 uint16_t iteration_id GNUNET_PACKED;
287 * Type of the element attachted to the message,
290 uint16_t element_type GNUNET_PACKED;
297 * Client acknowledges receiving element in iteration.
299 struct GNUNET_SET_IterAckMessage
302 * Type: #GNUNET_MESSAGE_TYPE_SET_ITER_ACK
304 struct GNUNET_MessageHeader header;
307 * Non-zero if the service should continue sending elements.
314 * Server responds to a lazy copy request.
316 struct GNUNET_SET_CopyLazyResponseMessage
319 * Type: #GNUNET_MESSAGE_TYPE_SET_COPY_LAZY_RESPONSE
321 struct GNUNET_MessageHeader header;
324 * Temporary name for the copied set.
331 * Client connects to a lazily copied set.
333 struct GNUNET_SET_CopyLazyConnectMessage
336 * Type: #GNUNET_MESSAGE_TYPE_SET_COPY_LAZY_CONNECT
338 struct GNUNET_MessageHeader header;
341 * Temporary name for the copied set.
347 GNUNET_NETWORK_STRUCT_END