2 This file is part of GNUnet.
3 (C) 2009 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 2, 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
26 #include "gnunet_crypto_lib.h"
27 #include "gnunet_time_lib.h"
30 * General core debugging.
32 #define DEBUG_CORE GNUNET_YES
35 * Debugging interaction core-clients.
37 #define DEBUG_CORE_CLIENT GNUNET_YES
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_FULL_INBOUND 4
49 #define GNUNET_CORE_OPTION_SEND_HDR_INBOUND 8
50 #define GNUNET_CORE_OPTION_SEND_FULL_OUTBOUND 16
51 #define GNUNET_CORE_OPTION_SEND_HDR_OUTBOUND 32
55 * Message transmitted core clients to gnunet-service-core
56 * to start the interaction. This header is followed by
57 * uint16_t type values specifying which messages this
58 * client is interested in.
64 * Header with type GNUNET_MESSAGE_TYPE_CORE_INIT.
66 struct GNUNET_MessageHeader header;
69 * Options, see GNUNET_CORE_OPTION_ values.
71 uint32_t options GNUNET_PACKED;
77 * Message transmitted by the gnunet-service-core process
78 * to its clients in response to an INIT message.
80 struct InitReplyMessage
84 * Header with type GNUNET_MESSAGE_TYPE_CORE_INIT_REPLY
86 struct GNUNET_MessageHeader header;
91 uint32_t reserved GNUNET_PACKED;
94 * Public key of the local peer.
96 struct GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded publicKey;
102 * Message sent by the service to clients to notify them
103 * about a peer connecting or disconnecting.
105 struct ConnectNotifyMessage
108 * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_CONNECT
109 * or GNUNET_MESSAGE_TYPE_CORE_NOTIFY_DISCONNECT.
111 struct GNUNET_MessageHeader header;
116 uint32_t reserved GNUNET_PACKED;
119 * Identity of the connecting peer.
121 struct GNUNET_PeerIdentity peer;
128 * Message sent by the service to clients to notify them about
129 * messages being received or transmitted. This overall message is
130 * followed by the real message, or just the header of the real
131 * message (depending on the client's preferences). The receiver can
132 * tell if he got the full message or only a partial message by
133 * looking at the size field in the header of NotifyTrafficMessage and
134 * checking it with the size field in the message that follows.
136 struct NotifyTrafficMessage
139 * Header with type GNUNET_MESSAGE_TYPE_CORE_NOTIFY_INBOUND
140 * or GNUNET_MESSAGE_TYPE_CORE_NOTIFY_OUTBOUND.
142 struct GNUNET_MessageHeader header;
147 uint32_t reserved GNUNET_PACKED;
150 * Identity of the receiver or sender.
152 struct GNUNET_PeerIdentity peer;
158 * Message sent to the core asking for configuration
159 * information and possibly preference changes.
161 struct RequestInfoMessage
164 * Header with type GNUNET_MESSAGE_TYPE_CORE_REQUEST_CONFIGURE
166 struct GNUNET_MessageHeader header;
171 uint32_t reserved GNUNET_PACKED;
174 * Limit the number of bytes of outbound traffic to this
175 * peer to at most the specified amount (naturally, the
176 * amount is also limited by the receiving peer).
178 uint32_t limit_outbound_bpm GNUNET_PACKED;
181 * Number of bytes of inbound traffic to reserve, can
182 * be negative (to unreserve). NBO.
184 int32_t reserve_inbound GNUNET_PACKED;
187 * Increment the current traffic preference for the given peer by
188 * the specified amont. The traffic preference is used to determine
189 * the share of bandwidth this peer will typcially be assigned.
191 uint64_t preference_change GNUNET_PACKED;
194 * Identity of the peer being configured.
196 struct GNUNET_PeerIdentity peer;
202 * Response from the core to a "RequestInfoMessage"
203 * providing traffic status information for a peer.
205 struct ConfigurationInfoMessage
208 * Header with type GNUNET_MESSAGE_TYPE_CORE_CONFIGURATION_INFO
210 struct GNUNET_MessageHeader header;
213 * Amount of traffic (inbound number of bytes) that was reserved in
214 * response to the configuration change request. Negative for
215 * "unreserved" bytes.
217 int32_t reserved_amount GNUNET_PACKED;
220 * Available bandwidth in (in bytes per minute) for this peer.
221 * 0 if we have been disconnected.
223 uint32_t bpm_in GNUNET_PACKED;
226 * Available bandwidth out (in bytes per minute) for this peer,
227 * 0 if we have been disconnected.
229 uint32_t bpm_out GNUNET_PACKED;
232 * Latest transport latency estimate for the peer.
233 * FOREVER if we have been disconnected.
235 struct GNUNET_TIME_RelativeNBO latency;
238 * Current traffic preference for the peer.
239 * 0 if we have been disconnected.
244 * Identity of the receiver or sender.
246 struct GNUNET_PeerIdentity peer;
252 * Client asking core to transmit a particular message to
253 * a particular target. Does NOT have to be solicited.
258 * Header with type GNUNET_MESSAGE_TYPE_CORE_SEND
260 struct GNUNET_MessageHeader header;
263 * How important is this message?
265 uint32_t priority GNUNET_PACKED;
268 * By what time would the sender really like to see this
269 * message transmitted?
271 struct GNUNET_TIME_AbsoluteNBO deadline;
274 * Identity of the receiver or sender.
276 struct GNUNET_PeerIdentity peer;