2 This file is part of GNUnet.
3 (C) 2009, 2010, 2011 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_transport_service.h
23 * @brief low-level P2P IO
24 * @author Christian Grothoff
27 #ifndef GNUNET_TRANSPORT_SERVICE_H
28 #define GNUNET_TRANSPORT_SERVICE_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_util_lib.h"
39 #include "gnunet_ats_service.h"
42 * Version number of the transport API.
44 #define GNUNET_TRANSPORT_VERSION 0x00000000
48 * Function called by the transport for each received message.
51 * @param peer (claimed) identity of the other peer
52 * @param message the message
53 * @param ats performance data
54 * @param ats_count number of entries in ats
56 typedef void (*GNUNET_TRANSPORT_ReceiveCallback) (void *cls,
58 GNUNET_PeerIdentity * peer,
60 GNUNET_MessageHeader *
65 * Opaque handle to the service.
67 struct GNUNET_TRANSPORT_Handle;
71 * Function called to notify transport users that another
72 * peer connected to us.
75 * @param peer the peer that connected
76 * @param ats performance data
77 * @param ats_count number of entries in ats (excluding 0-termination)
79 typedef void (*GNUNET_TRANSPORT_NotifyConnect) (void *cls,
80 const struct GNUNET_PeerIdentity
83 GNUNET_ATS_Information * ats,
87 * Function called to notify transport users that another
88 * peer disconnected from us.
91 * @param peer the peer that disconnected
93 typedef void (*GNUNET_TRANSPORT_NotifyDisconnect) (void *cls,
95 GNUNET_PeerIdentity * peer);
99 * Function to call with result of the try connect request.
103 * @param result GNUNET_OK if message was transmitted to transport service
104 * GNUNET_SYSERR if message was not transmitted to transport service
106 typedef void (*GNUNET_TRANSPORT_TryConnectCallback) (void *cls,
111 * Function to call with a textual representation of an address.
112 * This function will be called several times with different possible
113 * textual representations, and a last time with NULL to signal the end
117 * @param address NULL on error or end of iteration,
118 * otherwise 0-terminated printable UTF-8 string
120 typedef void (*GNUNET_TRANSPORT_AddressToStringCallback) (void *cls,
121 const char *address);
125 * Function to call with a binary format of an address
128 * @param peer peer this update is about (never NULL)
129 * @param address address, NULL for disconnect notification in monitor mode
131 typedef void (*GNUNET_TRANSPORT_PeerIterateCallback) (void *cls,
133 GNUNET_PeerIdentity *
136 GNUNET_HELLO_Address *
141 * Connect to the transport service. Note that the connection may
142 * complete (or fail) asynchronously.
144 * @param cfg configuration to use
145 * @param self our own identity (API should check that it matches
146 * the identity found by transport), or NULL (no check)
147 * @param cls closure for the callbacks
148 * @param rec receive function to call, or NULL
149 * @param nc function to call on connect events, or NULL
150 * @param nd function to call on disconnect events, or NULL
151 * @return NULL on error
153 struct GNUNET_TRANSPORT_Handle *
154 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
155 const struct GNUNET_PeerIdentity *self, void *cls,
156 GNUNET_TRANSPORT_ReceiveCallback rec,
157 GNUNET_TRANSPORT_NotifyConnect nc,
158 GNUNET_TRANSPORT_NotifyDisconnect nd);
162 * Disconnect from the transport service.
164 * @param handle handle returned from connect
167 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle);
171 * Opaque handle for a transmission-ready request.
173 struct GNUNET_TRANSPORT_TryConnectHandle;
177 * Ask the transport service to establish a connection to
180 * @param handle connection to transport service
181 * @param target who we should try to connect to
182 * @param cb callback to be called when request was transmitted to transport
184 * @param cb_cls closure for the callback
185 * @return a GNUNET_TRANSPORT_TryConnectHandle handle or
186 * NULL on failure (cb will not be called)
188 struct GNUNET_TRANSPORT_TryConnectHandle *
189 GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
190 const struct GNUNET_PeerIdentity *target,
191 GNUNET_TRANSPORT_TryConnectCallback cb,
196 * Cancel the request to transport to try a connect
197 * Callback will not be called
199 * @param tch GNUNET_TRANSPORT_TryConnectHandle handle to cancel
202 GNUNET_TRANSPORT_try_connect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch);
205 * Opaque handle for a transmission-ready request.
207 struct GNUNET_TRANSPORT_TransmitHandle;
211 * Check if we could queue a message of the given size for
212 * transmission. The transport service will take both its internal
213 * buffers and bandwidth limits imposed by the other peer into
214 * consideration when answering this query.
216 * @param handle connection to transport service
217 * @param target who should receive the message
218 * @param size how big is the message we want to transmit?
219 * @param priority how important is the message? @deprecated - remove?
220 * @param timeout after how long should we give up (and call
221 * notify with buf NULL and size 0)?
222 * @param notify function to call when we are ready to
223 * send such a message
224 * @param notify_cls closure for notify
225 * @return NULL if someone else is already waiting to be notified
226 * non-NULL if the notify callback was queued (can be used to cancel
227 * using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
229 struct GNUNET_TRANSPORT_TransmitHandle *
230 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
231 const struct GNUNET_PeerIdentity
232 *target, size_t size, uint32_t priority,
233 struct GNUNET_TIME_Relative timeout,
234 GNUNET_CONNECTION_TransmitReadyNotify
235 notify, void *notify_cls);
239 * Cancel the specified transmission-ready notification.
241 * @param th handle of the transmission notification request to cancel
244 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
245 GNUNET_TRANSPORT_TransmitHandle
251 * Function called whenever there is an update to the
252 * HELLO of this peer.
255 * @param hello our updated HELLO
257 typedef void (*GNUNET_TRANSPORT_HelloUpdateCallback) (void *cls,
259 GNUNET_MessageHeader *
264 * Handle to cancel a 'GNUNET_TRANSPORT_get_hello' operation.
266 struct GNUNET_TRANSPORT_GetHelloHandle;
270 * Checks if a neighbour is connected
272 * @param handle connection to transport service
273 * @param peer the peer to check
274 * @return GNUNET_YES or GNUNET_NO
278 GNUNET_TRANSPORT_check_neighbour_connected (struct GNUNET_TRANSPORT_Handle *handle,
279 const struct GNUNET_PeerIdentity *peer);
283 * Set transport metrics for a peer and a direction
285 * @param handle transport handle
286 * @param peer the peer to set the metric for
287 * @param inbound set inbound direction (GNUNET_YES or GNUNET_NO)
288 * @param outbound set outbound direction (GNUNET_YES or GNUNET_NO)
289 * @param ats the metric as ATS information
290 * @param ats_count the number of metrics
292 * Supported ATS values:
293 * GNUNET_ATS_QUALITY_NET_DELAY (value in ms)
294 * GNUNET_ATS_QUALITY_NET_DISTANCE (value in count(hops))
297 * To enforce a delay of 10 ms for peer p1 in sending direction use:
299 * struct GNUNET_ATS_Information ats;
300 * ats.type = ntohl (GNUNET_ATS_QUALITY_NET_DELAY);
301 * ats.value = ntohl (10);
302 * GNUNET_TRANSPORT_set_traffic_metric (th, p1, TM_SEND, &ats, 1);
305 * Delay restrictions in receiving direction will be enforced with
309 GNUNET_TRANSPORT_set_traffic_metric (struct GNUNET_TRANSPORT_Handle *handle,
310 const struct GNUNET_PeerIdentity *peer,
313 const struct GNUNET_ATS_Information *ats,
318 * Obtain updates on changes to the HELLO message for this peer. The callback
319 * given in this function is never called synchronously.
321 * @param handle connection to transport service
322 * @param rec function to call with the HELLO
323 * @param rec_cls closure for rec
324 * @return handle to cancel the operation
326 struct GNUNET_TRANSPORT_GetHelloHandle *
327 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
328 GNUNET_TRANSPORT_HelloUpdateCallback rec,
333 * Stop receiving updates about changes to our HELLO message.
335 * @param ghh handle to cancel
338 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh);
342 * Offer the transport service the HELLO of another peer. Note that
343 * the transport service may just ignore this message if the HELLO is
344 * malformed or useless due to our local configuration.
346 * @param handle connection to transport service
347 * @param hello the hello message
348 * @param cont continuation to call when HELLO has been sent,
349 * tc reason GNUNET_SCHEDULER_REASON_TIMEOUT for fail
350 * tc reasong GNUNET_SCHEDULER_REASON_READ_READY for success
351 * @param cls closure for continuation
352 * @return a GNUNET_TRANSPORT_OfferHelloHandle handle or NULL on failure,
353 * in case of failure cont will not be called
356 struct GNUNET_TRANSPORT_OfferHelloHandle *
357 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
358 const struct GNUNET_MessageHeader *hello,
359 GNUNET_SCHEDULER_Task cont, void *cls);
363 * Cancel the request to transport to offer the HELLO message
365 * @param ohh the GNUNET_TRANSPORT_OfferHelloHandle to cancel
368 GNUNET_TRANSPORT_offer_hello_cancel (struct GNUNET_TRANSPORT_OfferHelloHandle *ohh);
371 * Handle to cancel a pending address lookup.
373 struct GNUNET_TRANSPORT_AddressToStringContext;
377 * Convert a binary address into a human readable address.
379 * @param cfg configuration to use
380 * @param address address to convert (binary format)
381 * @param numeric should (IP) addresses be displayed in numeric form
382 * (otherwise do reverse DNS lookup)
383 * @param timeout how long is the lookup allowed to take at most
384 * @param aluc function to call with the results
385 * @param aluc_cls closure for aluc
386 * @return handle to cancel the operation, NULL on error
388 struct GNUNET_TRANSPORT_AddressToStringContext *
389 GNUNET_TRANSPORT_address_to_string (const struct GNUNET_CONFIGURATION_Handle
391 const struct GNUNET_HELLO_Address *address,
393 struct GNUNET_TIME_Relative timeout,
394 GNUNET_TRANSPORT_AddressToStringCallback
395 aluc, void *aluc_cls);
399 * Cancel request for address conversion.
401 * @param alc handle for the request to cancel
404 GNUNET_TRANSPORT_address_to_string_cancel (struct
405 GNUNET_TRANSPORT_AddressToStringContext
410 * Return all the known addresses for a specific peer or all peers.
411 * Returns continuously all address if one_shot is set to GNUNET_NO
413 * CHANGE: Returns the address(es) that we are currently using for this
414 * peer. Upon completion, the 'AddressLookUpCallback' is called one more
415 * time with 'NULL' for the address and the peer. After this, the operation must no
416 * longer be explicitly cancelled.
418 * @param cfg configuration to use
419 * @param peer peer identity to look up the addresses of, CHANGE: allow NULL for all (connected) peers
420 * @param one_shot GNUNET_YES to return the current state and then end (with NULL+NULL),
421 * GNUNET_NO to monitor the set of addresses used (continuously, must be explicitly canceled, NOT implemented yet!)
422 * @param timeout how long is the lookup allowed to take at most
423 * @param peer_address_callback function to call with the results
424 * @param peer_address_callback_cls closure for peer_address_callback
426 struct GNUNET_TRANSPORT_PeerIterateContext *
427 GNUNET_TRANSPORT_peer_get_active_addresses (const struct
428 GNUNET_CONFIGURATION_Handle *cfg,
429 const struct GNUNET_PeerIdentity
431 struct GNUNET_TIME_Relative timeout,
432 GNUNET_TRANSPORT_PeerIterateCallback
433 peer_address_callback,
434 void *peer_address_callback_cls);
438 * Cancel request for peer lookup.
440 * @param alc handle for the request to cancel
443 GNUNET_TRANSPORT_peer_get_active_addresses_cancel (struct
444 GNUNET_TRANSPORT_PeerIterateContext
449 * Handle for blacklisting peers.
451 struct GNUNET_TRANSPORT_Blacklist;
455 * Function that decides if a connection is acceptable or not.
458 * @param pid peer to approve or disapproave
459 * @return GNUNET_OK if the connection is allowed, GNUNET_SYSERR if not
461 typedef int (*GNUNET_TRANSPORT_BlacklistCallback) (void *cls,
463 GNUNET_PeerIdentity * pid);
467 * Install a blacklist callback. The service will be queried for all
468 * existing connections as well as any fresh connections to check if
469 * they are permitted. If the blacklisting callback is unregistered,
470 * all hosts that were denied in the past will automatically be
471 * whitelisted again. Cancelling the blacklist handle is also the
472 * only way to re-enable connections from peers that were previously
475 * @param cfg configuration to use
476 * @param cb callback to invoke to check if connections are allowed
477 * @param cb_cls closure for cb
478 * @return NULL on error, otherwise handle for cancellation
480 struct GNUNET_TRANSPORT_Blacklist *
481 GNUNET_TRANSPORT_blacklist (const struct GNUNET_CONFIGURATION_Handle *cfg,
482 GNUNET_TRANSPORT_BlacklistCallback cb,
487 * Abort the blacklist. Note that this function is the only way for
488 * removing a peer from the blacklist.
490 * @param br handle of the request that is to be cancelled
493 GNUNET_TRANSPORT_blacklist_cancel (struct GNUNET_TRANSPORT_Blacklist *br);
497 #if 0 /* keep Emacsens' auto-indent happy */
504 /* ifndef GNUNET_TRANSPORT_SERVICE_H */
506 /* end of gnunet_transport_service.h */