-rename file
[oweals/gnunet.git] / src / set / gnunet-service-set_protocol.h
1 /*
2      This file is part of GNUnet.
3      (C) 2013 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 3, 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  * @author Florian Dold
23  * @file set/set_protocol.h
24  * @brief Peer-to-Peer messages for gnunet set
25  */
26 #ifndef SET_PROTOCOL_H
27 #define SET_PROTOCOL_H
28
29 #include "platform.h"
30 #include "gnunet_common.h"
31
32
33 GNUNET_NETWORK_STRUCT_BEGIN
34
35 struct OperationRequestMessage
36 {
37   /**
38    * Type: #GNUNET_MESSAGE_TYPE_SET_P2P_OPERATION_REQUEST
39    */
40   struct GNUNET_MessageHeader header;
41
42   /**
43    * Operation to request, values from `enum GNUNET_SET_OperationType`
44    */
45   uint32_t operation GNUNET_PACKED;
46
47   /**
48    * Salt to use for this operation.
49    */
50   uint32_t salt GNUNET_PACKED;
51
52   /**
53    * For Intersection: my element count
54    */
55   uint32_t element_count GNUNET_PACKED;
56
57   /**
58    * Application-specific identifier of the request.
59    */
60   struct GNUNET_HashCode app_id;
61
62   /* rest: optional message */
63 };
64
65
66 struct IBFMessage
67 {
68   /**
69    * Type: #GNUNET_MESSAGE_TYPE_SET_P2P_IBF
70    */
71   struct GNUNET_MessageHeader header;
72
73   /**
74    * Order of the whole ibf, where
75    * num_buckets = 2^order
76    */
77   uint8_t order;
78
79   /**
80    * Padding, must be 0.
81    */
82   uint8_t reserved;
83
84   /**
85    * Offset of the strata in the rest of the message
86    */
87   uint16_t offset GNUNET_PACKED;
88
89   /**
90    * Salt used when hashing elements for this IBF.
91    */
92   uint32_t salt GNUNET_PACKED;
93
94   /* rest: strata */
95 };
96
97
98 struct BFMessage
99 {
100   /**
101    * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF
102    */
103   struct GNUNET_MessageHeader header;
104
105   /**
106    * mutator used with this bloomfilter.
107    */
108   uint32_t sender_element_count GNUNET_PACKED;
109
110   /**
111    * mutator used with this bloomfilter.
112    */
113   uint32_t sender_mutator GNUNET_PACKED;
114
115   /**
116    * Length of the bloomfilter data
117    */
118   uint32_t bloomfilter_total_length GNUNET_PACKED;
119
120   /**
121    * Length of the appended bloomfilter data block
122    */
123   uint32_t bloomfilter_length GNUNET_PACKED;
124
125   /**
126    * Length of the bloomfilter data
127    */
128   uint32_t bits_per_element GNUNET_PACKED;
129
130   /**
131    * rest: the sender's bloomfilter
132    */
133 };
134
135
136 struct BFPart
137 {
138   /**
139    * Type: #GNUNET_MESSAGE_TYPE_SET_INTERSECTION_P2P_BF
140    */
141   struct GNUNET_MessageHeader header;
142
143   /**
144    * Length of the appended bloomfilter data block
145    */
146   uint32_t chunk_length GNUNET_PACKED;
147
148   /**
149    * offset in the bloolfilter data block, if multipart message
150    */
151   uint32_t chunk_offset GNUNET_PACKED;
152
153   /**
154    * rest: the sender's bloomfilter
155    */
156 };
157
158 GNUNET_NETWORK_STRUCT_END
159
160 #endif