2 This file is part of GNUnet.
3 Copyright (C) 2009-2014 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
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
48 * Client cares about connectivity changes.
50 #define GNUNET_CORE_OPTION_SEND_STATUS_CHANGE 4
53 * Client wants all inbound messages in full.
55 #define GNUNET_CORE_OPTION_SEND_FULL_INBOUND 8
58 * Client just wants the 4-byte message headers of
59 * all inbound messages.
61 #define GNUNET_CORE_OPTION_SEND_HDR_INBOUND 16
64 * Client wants all outbound messages in full.
66 #define GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND 32
69 * Client just wants the 4-byte message headers of
70 * all outbound messages.
72 #define GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND 64
75 GNUNET_NETWORK_STRUCT_BEGIN
78 * Message transmitted core clients to gnunet-service-core
79 * to start the interaction. This header is followed by
80 * uint16_t type values specifying which messages this
81 * client is interested in.
86 * Header with type #GNUNET_MESSAGE_TYPE_CORE_INIT.
88 struct GNUNET_MessageHeader header;
91 * Options, see GNUNET_CORE_OPTION_ values.
93 uint32_t options GNUNET_PACKED;
98 * Message transmitted by the gnunet-service-core process
99 * to its clients in response to an INIT message.
101 struct InitReplyMessage
104 * Header with type #GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY
106 struct GNUNET_MessageHeader header;
111 uint32_t reserved GNUNET_PACKED;
114 * Public key of the local peer.
116 struct GNUNET_PeerIdentity my_identity;
121 * Message sent by the service to clients to notify them
122 * about a peer connecting.
124 struct ConnectNotifyMessage
127 * Header with type #GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT
129 struct GNUNET_MessageHeader header;
134 uint32_t reserved GNUNET_PACKED;
137 * Identity of the connecting peer.
139 struct GNUNET_PeerIdentity peer;
144 * Message sent by the service to clients to notify them
145 * about a peer disconnecting.
147 struct DisconnectNotifyMessage
150 * Header with type #GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT.
152 struct GNUNET_MessageHeader header;
157 uint32_t reserved GNUNET_PACKED;
160 * Identity of the connecting peer.
162 struct GNUNET_PeerIdentity peer;
167 * Message sent by the service to clients to notify them about
168 * messages being received or transmitted. This overall message is
169 * followed by the real message, or just the header of the real
170 * message (depending on the client's preferences). The receiver can
171 * tell if it got the full message or only a partial message by
172 * looking at the size field in the header of NotifyTrafficMessage and
173 * checking it with the size field in the message that follows.
175 struct NotifyTrafficMessage
178 * Header with type #GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND
179 * or #GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND.
181 struct GNUNET_MessageHeader header;
184 * Identity of the receiver or sender.
186 struct GNUNET_PeerIdentity peer;
188 /* Followed by payload (message or just header), variable size */
193 * Client notifying core about the maximum-priority
194 * message it has in the queue for a particular target.
196 struct SendMessageRequest
199 * Header with type #GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST
201 struct GNUNET_MessageHeader header;
204 * How important is this message?
206 uint32_t priority GNUNET_PACKED;
209 * By what time would the sender really like to see this
210 * message transmitted?
212 struct GNUNET_TIME_AbsoluteNBO deadline;
215 * Identity of the intended target.
217 struct GNUNET_PeerIdentity peer;
222 uint32_t reserved GNUNET_PACKED;
225 * How large is the message?
227 uint16_t size GNUNET_PACKED;
230 * Counter for this peer to match SMRs to replies.
232 uint16_t smr_id GNUNET_PACKED;
237 * Core notifying client that it is allowed to now
238 * transmit a message to the given target
239 * (response to #GNUNET_MESSAGE_TYPE_CORE_SEND_REQUEST).
241 struct SendMessageReady
244 * Header with type #GNUNET_MESSAGE_TYPE_CORE_SEND_READY
246 struct GNUNET_MessageHeader header;
249 * How many bytes are allowed for transmission?
250 * Guaranteed to be at least as big as the requested size,
251 * or ZERO if the request is rejected (will timeout,
252 * peer disconnected, queue full, etc.).
254 uint16_t size GNUNET_PACKED;
257 * smr_id from the request.
259 uint16_t smr_id GNUNET_PACKED;
262 * Identity of the intended target.
264 struct GNUNET_PeerIdentity peer;
269 * Client asking core to transmit a particular message to a particular
270 * target (response to #GNUNET_MESSAGE_TYPE_CORE_SEND_READY).
275 * Header with type #GNUNET_MESSAGE_TYPE_CORE_SEND
277 struct GNUNET_MessageHeader header;
280 * How important is this message? Contains a
281 * `enum GNUNET_MQ_PriorityPreferences` in NBO.
283 uint32_t priority GNUNET_PACKED;
286 * By what time would the sender really like to see this
287 * message transmitted?
289 struct GNUNET_TIME_AbsoluteNBO deadline;
292 * Identity of the intended receiver.
294 struct GNUNET_PeerIdentity peer;
299 * Message sent by the service to monitor clients to notify them
300 * about a peer changing status.
302 struct MonitorNotifyMessage
305 * Header with type #GNUNET_MESSAGE_TYPE_CORE_MONITOR_NOTIFY
307 struct GNUNET_MessageHeader header;
310 * New peer state, an `enum GNUNET_CORE_KxState` in NBO.
312 uint32_t state GNUNET_PACKED;
315 * Identity of the peer.
317 struct GNUNET_PeerIdentity peer;
320 * How long will we stay in this state (if nothing else happens)?
322 struct GNUNET_TIME_AbsoluteNBO timeout;
326 GNUNET_NETWORK_STRUCT_END