2 This file is part of GNUnet.
3 Copyright (C) 2013, 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.
21 * @author Florian Dold
22 * @author Christian Grothoff
23 * @file set/gnunet-service-set_protocol.h
24 * @brief Peer-to-Peer messages for gnunet set
26 #ifndef SET_PROTOCOL_H
27 #define SET_PROTOCOL_H
30 #include "gnunet_common.h"
33 GNUNET_NETWORK_STRUCT_BEGIN
35 struct OperationRequestMessage
38 * Type: #GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST
40 struct GNUNET_MessageHeader header;
43 * Operation to request, values from `enum GNUNET_SET_OperationType`
45 uint32_t operation GNUNET_PACKED;
48 * For Intersection: my element count
50 uint32_t element_count GNUNET_PACKED;
53 * Application-specific identifier of the request.
55 struct GNUNET_HashCode app_id;
57 /* rest: optional message */
62 * Message containing buckets of an invertible bloom filter.
64 * If an IBF has too many buckets for an IBF message,
65 * it is split into multiple messages.
70 * Type: #GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF
72 struct GNUNET_MessageHeader header;
75 * Order of the whole ibf, where
76 * num_buckets = 2^order
88 uint16_t reserved2 GNUNET_PACKED;
91 * Offset of the strata in the rest of the message
93 uint32_t offset GNUNET_PACKED;
96 * Salt used when hashing elements for this IBF.
98 uint32_t salt GNUNET_PACKED;
104 struct InquiryMessage
107 * Type: #GNUNET_MESSAGE_TYPE_SET_UNION_P2P_IBF
109 struct GNUNET_MessageHeader header;
112 * Salt used when hashing elements for this inquiry.
114 uint32_t salt GNUNET_PACKED;
117 * Reserved, set to 0.
119 uint32_t reserved GNUNET_PACKED;
121 /* rest: inquiry IBF keys */
126 * During intersection, the first (and possibly second) message
127 * send it the number of elements in the set, to allow the peers
128 * to decide who should start with the Bloom filter.
130 struct IntersectionElementInfoMessage
133 * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_ELEMENT_INFO
135 struct GNUNET_MessageHeader header;
138 * mutator used with this bloomfilter.
140 uint32_t sender_element_count GNUNET_PACKED;
146 * Bloom filter messages exchanged for set intersection calculation.
151 * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF
153 struct GNUNET_MessageHeader header;
156 * Number of elements the sender still has in the set.
158 uint32_t sender_element_count GNUNET_PACKED;
161 * XOR of all hashes over all elements remaining in the set.
162 * Used to determine termination.
164 struct GNUNET_HashCode element_xor_hash;
167 * Mutator used with this bloomfilter.
169 uint32_t sender_mutator GNUNET_PACKED;
172 * Total length of the bloomfilter data.
174 uint32_t bloomfilter_total_length GNUNET_PACKED;
177 * Number of bits (k-value) used in encoding the bloomfilter.
179 uint32_t bits_per_element GNUNET_PACKED;
182 * rest: the sender's bloomfilter
188 * Last message, send to confirm the final set. Contains the element
189 * count as it is possible that the peer determined that we were done
190 * by getting the empty set, which in that case also needs to be
193 struct IntersectionDoneMessage
196 * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_DONE
198 struct GNUNET_MessageHeader header;
201 * Final number of elements in intersection.
203 uint32_t final_element_count GNUNET_PACKED;
206 * XOR of all hashes over all elements remaining in the set.
208 struct GNUNET_HashCode element_xor_hash;
211 GNUNET_NETWORK_STRUCT_END