2 This file is part of GNUnet.
3 (C) 2009, 2010 Christian Grothoff (and other contributing authors)
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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
23 * @brief common internal definitions for core service
24 * @author Christian Grothoff
29 #include "gnunet_bandwidth_lib.h"
30 #include "gnunet_transport_service.h"
31 #include "gnunet_crypto_lib.h"
32 #include "gnunet_time_lib.h"
35 * General core debugging.
37 #define DEBUG_CORE GNUNET_EXTRA_LOGGING
40 * Definition of bits in the InitMessage's options field that specify
41 * which events this client cares about. Note that inbound messages
42 * for handlers that were specifically registered are always
43 * transmitted to the client.
45 #define GNUNET_CORE_OPTION_NOTHING 0
46 #define GNUNET_CORE_OPTION_SEND_STATUS_CHANGE 4
47 #define GNUNET_CORE_OPTION_SEND_FULL_INBOUND 8
48 #define GNUNET_CORE_OPTION_SEND_HDR_INBOUND 16
49 #define GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND 32
50 #define GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND 64
53 GNUNET_NETWORK_STRUCT_BEGIN
56 * Message transmitted core clients to gnunet-service-core
57 * to start the interaction. This header is followed by
58 * uint16_t type values specifying which messages this
59 * client is interested in.
65 * Header with type GNUNET_MESSAGE_TYPE_CORE_INIT.
67 struct GNUNET_MessageHeader header;
70 * Options, see GNUNET_CORE_OPTION_ values.
72 uint32_t options GNUNET_PACKED;
78 * Message transmitted by the gnunet-service-core process
79 * to its clients in response to an INIT message.
81 struct InitReplyMessage
85 * Header with type GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY
87 struct GNUNET_MessageHeader header;
92 uint32_t reserved GNUNET_PACKED;
95 * Public key of the local peer.
97 struct GNUNET_PeerIdentity my_identity;
103 * Message sent by the service to clients to notify them
104 * about a peer connecting.
106 struct ConnectNotifyMessage
109 * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT
111 struct GNUNET_MessageHeader header;
114 * Number of ATS key-value pairs that follow this struct
115 * (excluding the 0-terminator).
117 uint32_t ats_count GNUNET_PACKED;
120 * Identity of the connecting peer.
122 struct GNUNET_PeerIdentity peer;
128 * Message sent by the service to clients to notify them
129 * about a peer changing status.
131 struct PeerStatusNotifyMessage
134 * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_PEER_STATUS
136 struct GNUNET_MessageHeader header;
139 * Number of ATS key-value pairs that follow this struct
140 * (excluding the 0-terminator).
142 uint32_t ats_count GNUNET_PACKED;
145 * When the peer would time out (unless we see activity)
147 struct GNUNET_TIME_AbsoluteNBO timeout;
150 * Available bandwidth from the peer.
152 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
155 * Available bandwidth to the peer.
157 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
160 * Identity of the peer.
162 struct GNUNET_PeerIdentity peer;
165 * First of the ATS information blocks (we must have at least
166 * one due to the 0-termination requirement).
168 struct GNUNET_ATS_Information ats;
174 * Message sent by the service to clients to notify them
175 * about a peer disconnecting.
177 struct DisconnectNotifyMessage
180 * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT.
182 struct GNUNET_MessageHeader header;
187 uint32_t reserved GNUNET_PACKED;
190 * Identity of the connecting peer.
192 struct GNUNET_PeerIdentity peer;
198 * Message sent by the service to clients to notify them about
199 * messages being received or transmitted. This overall message is
200 * followed by the real message, or just the header of the real
201 * message (depending on the client's preferences). The receiver can
202 * tell if he got the full message or only a partial message by
203 * looking at the size field in the header of NotifyTrafficMessage and
204 * checking it with the size field in the message that follows.
206 struct NotifyTrafficMessage
209 * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND
210 * or GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND.
212 struct GNUNET_MessageHeader header;
215 * Number of ATS key-value pairs that follow this struct
216 * (excluding the 0-terminator).
218 uint32_t ats_count GNUNET_PACKED;
221 * Identity of the receiver or sender.
223 struct GNUNET_PeerIdentity peer;
226 * First of the ATS information blocks (we must have at least
227 * one due to the 0-termination requirement).
229 struct GNUNET_ATS_Information ats;
235 * Client notifying core about the maximum-priority
236 * message it has in the queue for a particular target.
238 struct SendMessageRequest
241 * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST
243 struct GNUNET_MessageHeader header;
246 * How important is this message?
248 uint32_t priority GNUNET_PACKED;
251 * By what time would the sender really like to see this
252 * message transmitted?
254 struct GNUNET_TIME_AbsoluteNBO deadline;
257 * Identity of the intended target.
259 struct GNUNET_PeerIdentity peer;
262 * How large is the client's message queue for this peer?
264 uint32_t queue_size GNUNET_PACKED;
267 * How large is the message?
269 uint16_t size GNUNET_PACKED;
272 * Counter for this peer to match SMRs to replies.
274 uint16_t smr_id GNUNET_PACKED;
280 * Core notifying client that it is allowed to now
281 * transmit a message to the given target
282 * (response to GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST).
284 struct SendMessageReady
287 * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND_READY
289 struct GNUNET_MessageHeader header;
292 * How many bytes are allowed for transmission?
293 * Guaranteed to be at least as big as the requested size,
294 * or ZERO if the request is rejected (will timeout,
295 * peer disconnected, queue full, etc.).
297 uint16_t size GNUNET_PACKED;
300 * smr_id from the request.
302 uint16_t smr_id GNUNET_PACKED;
305 * Identity of the intended target.
307 struct GNUNET_PeerIdentity peer;
313 * Client asking core to transmit a particular message to a particular
314 * target (response to GNUNET_MESSAGE_TYPE_CORE_SEND_READY).
319 * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND
321 struct GNUNET_MessageHeader header;
324 * How important is this message?
326 uint32_t priority GNUNET_PACKED;
329 * By what time would the sender really like to see this
330 * message transmitted?
332 struct GNUNET_TIME_AbsoluteNBO deadline;
335 * Identity of the receiver or sender.
337 struct GNUNET_PeerIdentity peer;
340 * GNUNET_YES if corking is allowed, GNUNET_NO if not.
342 uint32_t cork GNUNET_PACKED;
347 uint64_t reserved GNUNET_PACKED;
353 * Client asking core to connect to a particular target. There is no
354 * response from the core to this type of request (however, if an
355 * actual connection is created or destroyed, be it because of this
356 * type request or not, the core generally needs to notify the
359 struct ConnectMessage
362 * Header with type GNUNET_MESSAGE_TYPE_REQUEST_CONNECT or
363 * GNUNET_MESSAGE_TYPE_REQUEST_DISCONNECT.
365 struct GNUNET_MessageHeader header;
370 uint32_t reserved GNUNET_PACKED;
373 * Identity of the other peer.
375 struct GNUNET_PeerIdentity peer;
378 GNUNET_NETWORK_STRUCT_END