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.
22 * @file include/gnunet_core_service.h
23 * @brief core service; this is the main API for encrypted P2P
25 * @author Christian Grothoff
28 #ifndef GNUNET_CORE_SERVICE_H
29 #define GNUNET_CORE_SERVICE_H
34 #if 0 /* keep Emacsens' auto-indent happy */
39 #include "gnunet_util_lib.h"
40 #include "gnunet_transport_service.h"
43 * Version number of GNUnet-core API.
45 #define GNUNET_CORE_VERSION 0x00000000
49 * Opaque handle to the service.
51 struct GNUNET_CORE_Handle;
55 * Method called whenever a given peer connects.
58 * @param peer peer identity this notification is about
59 * @param atsi performance data for the connection
61 typedef void (*GNUNET_CORE_ConnectEventHandler) (void *cls,
63 GNUNET_PeerIdentity * peer,
65 GNUNET_TRANSPORT_ATS_Information
70 * Method called whenever a given peer has a status change.
73 * @param peer peer identity this notification is about
74 * @param timeout absolute time when this peer will time out
75 * unless we see some further activity from it
76 * @param bandwidth_in available amount of inbound bandwidth
77 * @param bandwidth_out available amount of outbound bandwidth
78 * @param atsi performance data for the connection
80 typedef void (*GNUNET_CORE_PeerStatusEventHandler) (void *cls,
82 GNUNET_PeerIdentity * peer,
84 GNUNET_BANDWIDTH_Value32NBO
87 GNUNET_BANDWIDTH_Value32NBO
89 struct GNUNET_TIME_Absolute
92 GNUNET_TRANSPORT_ATS_Information
97 * Method called whenever a peer disconnects.
100 * @param peer peer identity this notification is about
102 typedef void (*GNUNET_CORE_DisconnectEventHandler) (void *cls,
104 GNUNET_PeerIdentity * peer);
108 * Functions with this signature are called whenever a message is
109 * received or transmitted.
111 * @param cls closure (set from GNUNET_CORE_connect)
112 * @param peer the other peer involved (sender or receiver, NULL
113 * for loopback messages where we are both sender and receiver)
114 * @param message the actual message
115 * @param atsi performance data for the connection
116 * @return GNUNET_OK to keep the connection open,
117 * GNUNET_SYSERR to close it (signal serious error)
119 typedef int (*GNUNET_CORE_MessageCallback) (void *cls,
120 const struct GNUNET_PeerIdentity *
122 const struct GNUNET_MessageHeader *
125 GNUNET_TRANSPORT_ATS_Information *
130 * Message handler. Each struct specifies how to handle on particular
131 * type of message received.
133 struct GNUNET_CORE_MessageHandler
136 * Function to call for messages of "type".
138 GNUNET_CORE_MessageCallback callback;
141 * Type of the message this handler covers.
146 * Expected size of messages of this type. Use 0 for variable-size.
147 * If non-zero, messages of the given type will be discarded if they
148 * do not have the right size.
150 uint16_t expected_size;
156 * Function called after GNUNET_CORE_connect has succeeded
157 * (or failed for good). Note that the private key of the
158 * peer is intentionally not exposed here; if you need it,
159 * your process should try to read the private key file
160 * directly (which should work if you are authorized...).
163 * @param server handle to the server, NULL if we failed
164 * @param my_identity ID of this peer, NULL if we failed
165 * @param publicKey public key of this peer, NULL if we failed
167 typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
168 struct GNUNET_CORE_Handle * server,
169 const struct GNUNET_PeerIdentity *
172 GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded
177 * Connect to the core service. Note that the connection may complete
178 * (or fail) asynchronously. This function primarily causes the given
179 * callback notification functions to be invoked whenever the
180 * specified event happens. The maximum number of queued
181 * notifications (queue length) is per client but the queue is shared
182 * across all types of notifications. So a slow client that registers
183 * for 'outbound_notify' also risks missing 'inbound_notify' messages.
184 * Certain events (such as connect/disconnect notifications) are not
185 * subject to queue size limitations.
187 * @param cfg configuration to use
188 * @param queue_size size of the per-peer message queue
189 * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
190 * @param init callback to call on timeout or once we have successfully
191 * connected to the core service; note that timeout is only meaningful if init is not NULL
192 * @param connects function to call on peer connect, can be NULL
193 * @param disconnects function to call on peer disconnect / timeout, can be NULL
194 * @param status_events function to call on peer status changes, can be NULL
195 * @param inbound_notify function to call for all inbound messages, can be NULL
196 * note that the core is allowed to drop notifications about inbound
197 * messages if the client does not process them fast enough (for this
198 * notification type, a bounded queue is used)
199 * @param inbound_hdr_only set to GNUNET_YES if inbound_notify will only read the
200 * GNUNET_MessageHeader and hence we do not need to give it the full message;
201 * can be used to improve efficiency, ignored if inbound_notify is NULL
202 * note that the core is allowed to drop notifications about inbound
203 * messages if the client does not process them fast enough (for this
204 * notification type, a bounded queue is used)
205 * @param outbound_notify function to call for all outbound messages, can be NULL;
206 * note that the core is allowed to drop notifications about outbound
207 * messages if the client does not process them fast enough (for this
208 * notification type, a bounded queue is used)
209 * @param outbound_hdr_only set to GNUNET_YES if outbound_notify will only read the
210 * GNUNET_MessageHeader and hence we do not need to give it the full message
211 * can be used to improve efficiency, ignored if outbound_notify is NULL
212 * note that the core is allowed to drop notifications about outbound
213 * messages if the client does not process them fast enough (for this
214 * notification type, a bounded queue is used)
215 * @param handlers callbacks for messages we care about, NULL-terminated
216 * note that the core is allowed to drop notifications about inbound
217 * messages if the client does not process them fast enough (for this
218 * notification type, a bounded queue is used)
219 * @return handle to the core service (only useful for disconnect until 'init' is called),
220 * NULL on error (in this case, init is never called)
222 struct GNUNET_CORE_Handle *
223 GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
224 unsigned int queue_size, void *cls,
225 GNUNET_CORE_StartupCallback init,
226 GNUNET_CORE_ConnectEventHandler connects,
227 GNUNET_CORE_DisconnectEventHandler disconnects,
228 GNUNET_CORE_PeerStatusEventHandler status_events,
229 GNUNET_CORE_MessageCallback inbound_notify,
230 int inbound_hdr_only,
231 GNUNET_CORE_MessageCallback outbound_notify,
232 int outbound_hdr_only,
233 const struct GNUNET_CORE_MessageHandler *handlers);
237 * Disconnect from the core service. This function can only
238 * be called *after* all pending 'GNUNET_CORE_notify_transmit_ready'
239 * requests have been explicitly cancelled.
241 * @param handle connection to core to disconnect
244 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle);
248 * Handle for a request to the core to connect or disconnect
249 * from a particular peer. Can be used to cancel the request
250 * (before the 'cont'inuation is called).
252 struct GNUNET_CORE_PeerRequestHandle;
256 * Type of function called upon completion.
259 * @param success GNUNET_OK on success (which for request_connect
260 * ONLY means that we transmitted the connect request to CORE,
261 * it does not mean that we are actually now connected!);
262 * GNUNET_NO on timeout,
263 * GNUNET_SYSERR if core was shut down
265 typedef void (*GNUNET_CORE_ControlContinuation) (void *cls, int success);
269 * Request that the core should try to connect to a particular peer.
270 * Once the request has been transmitted to the core, the continuation
271 * function will be called. Note that this does NOT mean that a
272 * connection was successfully established -- it only means that the
273 * core will now try. Successful establishment of the connection
274 * will be signalled to the 'connects' callback argument of
275 * 'GNUNET_CORE_connect' only. If the core service does not respond
276 * to our connection attempt within the given time frame, 'cont' will
277 * be called with the TIMEOUT reason code.
279 * @param h core handle
280 * @param peer who should we connect to
281 * @param cont function to call once the request has been completed (or timed out)
282 * @param cont_cls closure for cont
283 * @return NULL on error (cont will not be called), otherwise handle for cancellation
285 struct GNUNET_CORE_PeerRequestHandle *
286 GNUNET_CORE_peer_request_connect (struct GNUNET_CORE_Handle *h,
287 const struct GNUNET_PeerIdentity *peer,
288 GNUNET_CORE_ControlContinuation cont,
293 * Cancel a pending request to connect to a particular peer. Must not
294 * be called after the 'cont' function was invoked.
296 * @param req request handle that was returned for the original request
299 GNUNET_CORE_peer_request_connect_cancel (struct GNUNET_CORE_PeerRequestHandle
304 * Function called with perference change information about the given peer.
307 * @param peer identifies the peer
308 * @param bandwidth_out available amount of outbound bandwidth
309 * @param amount set to the amount that was actually reserved or unreserved;
310 * either the full requested amount or zero (no partial reservations)
311 * @param res_delay if the reservation could not be satisfied (amount was 0), how
312 * long should the client wait until re-trying?
313 * @param preference current traffic preference for the given peer
315 typedef void (*GNUNET_CORE_PeerConfigurationInfoCallback) (void *cls,
317 GNUNET_PeerIdentity *
320 GNUNET_BANDWIDTH_Value32NBO
326 uint64_t preference);
331 * Context that can be used to cancel a peer information request.
333 struct GNUNET_CORE_InformationRequestContext;
337 * Obtain statistics and/or change preferences for the given peer.
338 * You can only have one such pending request per peer.
340 * @param h core handle
341 * @param peer identifies the peer
342 * @param timeout after how long should we give up (and call "info" with NULL
343 * for "peer" to signal an error)?
344 * @param bw_out set to the current bandwidth limit (sending) for this peer,
345 * caller should set "bpm_out" to "GNUNET_BANDWIDTH_VALUE_MAX" to avoid changing
346 * the current value; otherwise "bw_out" will be lowered to
347 * the specified value; passing a pointer to "0" can be used to force
348 * us to disconnect from the peer; "bw_out" might not increase
349 * as specified since the upper bound is generally
350 * determined by the other peer!
351 * @param amount reserve N bytes for receiving, negative
352 * amounts can be used to undo a (recent) reservation;
353 * @param preference increase incoming traffic share preference by this amount;
354 * in the absence of "amount" reservations, we use this
355 * preference value to assign proportional bandwidth shares
356 * to all connected peers
357 * @param info function to call with the resulting configuration information
358 * @param info_cls closure for info
359 * @return NULL on error
361 struct GNUNET_CORE_InformationRequestContext *
362 GNUNET_CORE_peer_change_preference (struct GNUNET_CORE_Handle *h,
363 const struct GNUNET_PeerIdentity *peer,
364 struct GNUNET_TIME_Relative timeout,
365 struct GNUNET_BANDWIDTH_Value32NBO bw_out,
366 int32_t amount, uint64_t preference,
367 GNUNET_CORE_PeerConfigurationInfoCallback
368 info, void *info_cls);
372 * Cancel request for getting information about a peer.
373 * Note that an eventual change in preference, trust or bandwidth
374 * assignment MAY have already been committed at the time,
375 * so cancelling a request is NOT sure to undo the original
376 * request. The original request may or may not still commit.
377 * The only thing cancellation ensures is that the callback
378 * from the original request will no longer be called.
380 * @param irc context returned by the original GNUNET_CORE_peer_get_info call
383 GNUNET_CORE_peer_change_preference_cancel (struct
384 GNUNET_CORE_InformationRequestContext
389 * Iterate over all connected peers.
391 * @param cfg configuration handle
392 * @param peer_cb function to call with the peer information
393 * @param cb_cls closure for peer_cb
394 * @return GNUNET_OK on success, GNUNET_SYSERR on errors
397 GNUNET_CORE_iterate_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
398 GNUNET_CORE_ConnectEventHandler peer_cb,
402 * Iterate over all currently connected peers.
403 * Calls peer_cb with each connected peer, and then
404 * once with NULL to indicate that all peers have
407 * @param cfg configuration to use
408 * @param peer the specific peer to check for
409 * @param peer_cb function to call with the peer information
410 * @param cb_cls closure for peer_cb
412 * @return GNUNET_OK if iterating, GNUNET_SYSERR on error
415 GNUNET_CORE_is_peer_connected (const struct GNUNET_CONFIGURATION_Handle *cfg,
416 struct GNUNET_PeerIdentity *peer,
417 GNUNET_CORE_ConnectEventHandler peer_cb,
422 * Handle for a transmission request.
424 struct GNUNET_CORE_TransmitHandle;
428 * Ask the core to call "notify" once it is ready to transmit the
429 * given number of bytes to the specified "target". Must only be
430 * called after a connection to the respective peer has been
431 * established (and the client has been informed about this).
434 * @param handle connection to core service
435 * @param cork is corking allowed for this transmission?
436 * @param priority how important is the message?
437 * @param maxdelay how long can the message wait?
438 * @param target who should receive the message,
439 * use NULL for this peer (loopback)
440 * @param notify_size how many bytes of buffer space does notify want?
441 * @param notify function to call when buffer space is available;
442 * will be called with NULL on timeout or if the overall queue
443 * for this peer is larger than queue_size and this is currently
444 * the message with the lowest priority; will also be called
445 * with 'NULL' buf if the peer disconnects; since the disconnect
446 * signal will be emmitted even later, clients MUST cancel
447 * all pending transmission requests DURING the disconnect
448 * handler (unless they ensure that 'notify' never calls
449 * 'GNUNET_CORE_notify_transmit_ready').
450 * @param notify_cls closure for notify
451 * @return non-NULL if the notify callback was queued,
452 * NULL if we can not even queue the request (insufficient
453 * memory); if NULL is returned, "notify" will NOT be called.
455 struct GNUNET_CORE_TransmitHandle *
456 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle, int cork,
458 struct GNUNET_TIME_Relative maxdelay,
459 const struct GNUNET_PeerIdentity *target,
461 GNUNET_CONNECTION_TransmitReadyNotify notify,
466 * Cancel the specified transmission-ready notification.
468 * @param th handle that was returned by "notify_transmit_ready".
471 GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
475 #if 0 /* keep Emacsens' auto-indent happy */
482 /* ifndef GNUNET_CORE_SERVICE_H */
484 /* end of gnunet_core_service.h */