aboutsummaryrefslogtreecommitdiff
path: root/src/set/set.h
blob: 87fd6efbfdade4eb4a9428aed5ca59e7fd64d068 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/*
     This file is part of GNUnet.
     (C) 2012 Christian Grothoff (and other contributing authors)

     GNUnet is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published
     by the Free Software Foundation; either version 2, or (at your
     option) any later version.

     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with GNUnet; see the file COPYING.  If not, write to the
     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     Boston, MA 02111-1307, USA.
*/

/**
 * @author Florian Dold
 * @file set/set.h
 * @brief messages used for the set api
 */
#ifndef SET_H
#define SET_H

#include "platform.h"
#include "gnunet_common.h"


/**
 * The service sends up to GNUNET_SET_ACK_WINDOW messages per client handle,
 * the client should send an ack every GNUNET_SET_ACK_WINDOW/2 messages.
 */
#define GNUNET_SET_ACK_WINDOW 8


GNUNET_NETWORK_STRUCT_BEGIN

struct SetCreateMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_SET_CREATE
   */
  struct GNUNET_MessageHeader header;

  /**
   * Operation type, values of enum GNUNET_SET_OperationType
   */
  uint16_t operation GNUNET_PACKED;
};


struct ListenMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_SET_LISTEN
   */
  struct GNUNET_MessageHeader header;

  /**
   * application id
   */
  struct GNUNET_HashCode app_id;

  /**
   * Operation type, values of enum GNUNET_SET_OperationType
   */
  uint16_t operation GNUNET_PACKED;
};


struct AcceptMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_SET_ACCEPT
   */
  struct GNUNET_MessageHeader header;

  /**
   * request id of the request we want to accept
   */
  uint32_t request_id GNUNET_PACKED;

  /**
   * Zero if the client has rejected the request,
   * non-zero if it has accepted it
   */
  uint32_t accepted GNUNET_PACKED;
};


struct RequestMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_SET_Request
   */
  struct GNUNET_MessageHeader header;

  /**
   * requesting peer
   */
  struct GNUNET_PeerIdentity peer_id;

  /**
   * request id of the request we want to accept
   */
  uint32_t request_id GNUNET_PACKED;

  /* rest: inner message */
};


struct EvaluateMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_SET_EVALUATE
   */
  struct GNUNET_MessageHeader header;

  /**
   * Peer to evaluate the operation with
   */
  struct GNUNET_PeerIdentity peer;

  /**
   * Application id
   */
  struct GNUNET_HashCode app_id;

  /**
   * id of our evaluate
   */
  uint32_t request_id GNUNET_PACKED;

  /**
   * Salt to use for the operation
   */
  uint16_t salt GNUNET_PACKED;

  /**
   * Padding
   */
  uint16_t reserved GNUNET_PACKED;

  /* rest: inner message */
};


struct ResultMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_SET_RESULT
   */
  struct GNUNET_MessageHeader header;

  /**
   * id the result belongs to
   */
  uint32_t request_id GNUNET_PACKED;

  /**
   * Was the evaluation successful?
   */
  uint16_t result_status GNUNET_PACKED;

  /**
   * Type of the element attachted to the message,
   * if any.
   */
  uint16_t element_type GNUNET_PACKED;

  /* rest: the actual element */
};


struct ElementMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_SET_ADD or
   *       GNUNET_MESSAGE_TYPE_SET_REMOVE
   */
  struct GNUNET_MessageHeader header;

  uint16_t element_type GNUNET_PACKED;

  /* rest: the actual element */
};


struct CancelMessage
{
  /**
   * Type: GNUNET_MESSAGE_TYPE_SET_CANCEL
   */
  struct GNUNET_MessageHeader header;

  /**
   * id we want to cancel result belongs to
   */
  uint32_t request_id GNUNET_PACKED;
};


GNUNET_NETWORK_STRUCT_END

#endif