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_CONNECT 1
47 #define GNUNET_CORE_OPTION_SEND_DISCONNECT 2
48 #define GNUNET_CORE_OPTION_SEND_STATUS_CHANGE 4
49 #define GNUNET_CORE_OPTION_SEND_FULL_INBOUND 8
50 #define GNUNET_CORE_OPTION_SEND_HDR_INBOUND 16
51 #define GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND 32
52 #define GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND 64
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;
125 * First of the ATS information blocks (we must have at least
126 * one due to the 0-termination requirement).
128 struct GNUNET_TRANSPORT_ATS_Information ats;
134 * Message sent by the service to clients to notify them
135 * about a peer changing status.
137 struct PeerStatusNotifyMessage
140 * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_PEER_STATUS
142 struct GNUNET_MessageHeader header;
145 * Number of ATS key-value pairs that follow this struct
146 * (excluding the 0-terminator).
148 uint32_t ats_count GNUNET_PACKED;
151 * When the peer would time out (unless we see activity)
153 struct GNUNET_TIME_AbsoluteNBO timeout;
156 * Available bandwidth from the peer.
158 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in;
161 * Available bandwidth to the peer.
163 struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out;
166 * Identity of the peer.
168 struct GNUNET_PeerIdentity peer;
171 * First of the ATS information blocks (we must have at least
172 * one due to the 0-termination requirement).
174 struct GNUNET_TRANSPORT_ATS_Information ats;
180 * Message sent by the service to clients to notify them
181 * about a peer disconnecting.
183 struct DisconnectNotifyMessage
186 * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT.
188 struct GNUNET_MessageHeader header;
193 uint32_t reserved GNUNET_PACKED;
196 * Identity of the connecting peer.
198 struct GNUNET_PeerIdentity peer;
204 * Message sent by the service to clients to notify them about
205 * messages being received or transmitted. This overall message is
206 * followed by the real message, or just the header of the real
207 * message (depending on the client's preferences). The receiver can
208 * tell if he got the full message or only a partial message by
209 * looking at the size field in the header of NotifyTrafficMessage and
210 * checking it with the size field in the message that follows.
212 struct NotifyTrafficMessage
215 * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND
216 * or GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND.
218 struct GNUNET_MessageHeader header;
221 * Number of ATS key-value pairs that follow this struct
222 * (excluding the 0-terminator).
224 uint32_t ats_count GNUNET_PACKED;
227 * Identity of the receiver or sender.
229 struct GNUNET_PeerIdentity peer;
232 * First of the ATS information blocks (we must have at least
233 * one due to the 0-termination requirement).
235 struct GNUNET_TRANSPORT_ATS_Information ats;
241 * Client notifying core about the maximum-priority
242 * message it has in the queue for a particular target.
244 struct SendMessageRequest
247 * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST
249 struct GNUNET_MessageHeader header;
252 * How important is this message?
254 uint32_t priority GNUNET_PACKED;
257 * By what time would the sender really like to see this
258 * message transmitted?
260 struct GNUNET_TIME_AbsoluteNBO deadline;
263 * Identity of the intended target.
265 struct GNUNET_PeerIdentity peer;
268 * How large is the client's message queue for this peer?
270 uint32_t queue_size GNUNET_PACKED;
273 * How large is the message?
275 uint16_t size GNUNET_PACKED;
278 * Counter for this peer to match SMRs to replies.
280 uint16_t smr_id GNUNET_PACKED;
286 * Core notifying client that it is allowed to now
287 * transmit a message to the given target
288 * (response to GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST).
290 struct SendMessageReady
293 * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND_READY
295 struct GNUNET_MessageHeader header;
298 * How many bytes are allowed for transmission?
299 * Guaranteed to be at least as big as the requested size,
300 * or ZERO if the request is rejected (will timeout,
301 * peer disconnected, queue full, etc.).
303 uint16_t size GNUNET_PACKED;
306 * smr_id from the request.
308 uint16_t smr_id GNUNET_PACKED;
311 * Identity of the intended target.
313 struct GNUNET_PeerIdentity peer;
319 * Client asking core to transmit a particular message to a particular
320 * target (response to GNUNET_MESSAGE_TYPE_CORE_SEND_READY).
325 * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND
327 struct GNUNET_MessageHeader header;
330 * How important is this message?
332 uint32_t priority GNUNET_PACKED;
335 * By what time would the sender really like to see this
336 * message transmitted?
338 struct GNUNET_TIME_AbsoluteNBO deadline;
341 * Identity of the receiver or sender.
343 struct GNUNET_PeerIdentity peer;
346 * GNUNET_YES if corking is allowed, GNUNET_NO if not.
348 uint32_t cork GNUNET_PACKED;
353 uint64_t reserved GNUNET_PACKED;
359 * Client asking core to connect to a particular target. There is no
360 * response from the core to this type of request (however, if an
361 * actual connection is created or destroyed, be it because of this
362 * type request or not, the core generally needs to notify the
365 struct ConnectMessage
368 * Header with type GNUNET_MESSAGE_TYPE_REQUEST_CONNECT or
369 * GNUNET_MESSAGE_TYPE_REQUEST_DISCONNECT.
371 struct GNUNET_MessageHeader header;
376 uint32_t reserved GNUNET_PACKED;
379 * Identity of the other peer.
381 struct GNUNET_PeerIdentity peer;