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 *
63 GNUNET_ATS_Information * ats,
68 * Opaque handle to the service.
70 struct GNUNET_TRANSPORT_Handle;
74 * Function called to notify transport users that another
75 * peer connected to us.
78 * @param peer the peer that connected
79 * @param ats performance data
80 * @param ats_count number of entries in ats (excluding 0-termination)
82 typedef void (*GNUNET_TRANSPORT_NotifyConnect) (void *cls,
83 const struct GNUNET_PeerIdentity
86 GNUNET_ATS_Information * ats,
90 * Function called to notify transport users that another
91 * peer disconnected from us.
94 * @param peer the peer that disconnected
96 typedef void (*GNUNET_TRANSPORT_NotifyDisconnect) (void *cls,
98 GNUNET_PeerIdentity * peer);
102 * Function to call with a textual representation of an address.
103 * This function will be called several times with different possible
104 * textual representations, and a last time with NULL to signal the end
108 * @param address NULL on error or end of iteration,
109 * otherwise 0-terminated printable UTF-8 string
111 typedef void (*GNUNET_TRANSPORT_AddressToStringCallback) (void *cls,
112 const char *address);
116 * Function to call with a binary format of an address
119 * @param peer peer this update is about (never NULL)
120 * @param address address, NULL for disconnect notification in monitor mode
122 typedef void (*GNUNET_TRANSPORT_PeerIterateCallback) (void *cls,
124 GNUNET_PeerIdentity *
127 GNUNET_HELLO_Address *
132 * Connect to the transport service. Note that the connection may
133 * complete (or fail) asynchronously.
135 * @param cfg configuration to use
136 * @param self our own identity (API should check that it matches
137 * the identity found by transport), or NULL (no check)
138 * @param cls closure for the callbacks
139 * @param rec receive function to call
140 * @param nc function to call on connect events
141 * @param nd function to call on disconnect events
142 * @return NULL on error
144 struct GNUNET_TRANSPORT_Handle *
145 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
146 const struct GNUNET_PeerIdentity *self, void *cls,
147 GNUNET_TRANSPORT_ReceiveCallback rec,
148 GNUNET_TRANSPORT_NotifyConnect nc,
149 GNUNET_TRANSPORT_NotifyDisconnect nd);
153 * Disconnect from the transport service.
155 * @param handle handle returned from connect
158 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle);
162 * Ask the transport service to establish a connection to
165 * @param handle connection to transport service
166 * @param target who we should try to connect to
167 * @return GNUNET_OK if request can be scheduled
168 * GNUNET_NO please retry later because we are reconnecting
169 * GNUNET_SYSERR on failure
172 GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
173 const struct GNUNET_PeerIdentity *target);
177 * Opaque handle for a transmission-ready request.
179 struct GNUNET_TRANSPORT_TransmitHandle;
183 * Check if we could queue a message of the given size for
184 * transmission. The transport service will take both its internal
185 * buffers and bandwidth limits imposed by the other peer into
186 * consideration when answering this query.
188 * @param handle connection to transport service
189 * @param target who should receive the message
190 * @param size how big is the message we want to transmit?
191 * @param priority how important is the message? @deprecated - remove?
192 * @param timeout after how long should we give up (and call
193 * notify with buf NULL and size 0)?
194 * @param notify function to call when we are ready to
195 * send such a message
196 * @param notify_cls closure for notify
197 * @return NULL if someone else is already waiting to be notified
198 * non-NULL if the notify callback was queued (can be used to cancel
199 * using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
201 struct GNUNET_TRANSPORT_TransmitHandle *
202 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
203 const struct GNUNET_PeerIdentity
204 *target, size_t size, uint32_t priority,
205 struct GNUNET_TIME_Relative timeout,
206 GNUNET_CONNECTION_TransmitReadyNotify
207 notify, void *notify_cls);
211 * Cancel the specified transmission-ready notification.
213 * @param th handle of the transmission notification request to cancel
216 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
217 GNUNET_TRANSPORT_TransmitHandle
223 * Function called whenever there is an update to the
224 * HELLO of this peer.
227 * @param hello our updated HELLO
229 typedef void (*GNUNET_TRANSPORT_HelloUpdateCallback) (void *cls,
231 GNUNET_MessageHeader *
236 * Handle to cancel a 'GNUNET_TRANSPORT_get_hello' operation.
238 struct GNUNET_TRANSPORT_GetHelloHandle;
242 * Obtain updates on changes to the HELLO message for this peer.
244 * @param handle connection to transport service
245 * @param rec function to call with the HELLO
246 * @param rec_cls closure for rec
247 * @return handle to cancel the operation
249 struct GNUNET_TRANSPORT_GetHelloHandle *
250 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
251 GNUNET_TRANSPORT_HelloUpdateCallback rec,
256 * Stop receiving updates about changes to our HELLO message.
258 * @param ghh handle returned from 'GNUNET_TRANSPORT_get_hello')
261 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh);
265 * Offer the transport service the HELLO of another peer. Note that
266 * the transport service may just ignore this message if the HELLO is
267 * malformed or useless due to our local configuration.
269 * @param handle connection to transport service
270 * @param hello the hello message
271 * @param cont continuation to call when HELLO has been sent
272 * @param cls closure for continuation
275 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
276 const struct GNUNET_MessageHeader *hello,
277 GNUNET_SCHEDULER_Task cont, void *cls);
281 * Handle to cancel a pending address lookup.
283 struct GNUNET_TRANSPORT_AddressToStringContext;
287 * Convert a binary address into a human readable address.
289 * @param cfg configuration to use
290 * @param address address to convert (binary format)
291 * @param numeric should (IP) addresses be displayed in numeric form
292 * (otherwise do reverse DNS lookup)
293 * @param timeout how long is the lookup allowed to take at most
294 * @param aluc function to call with the results
295 * @param aluc_cls closure for aluc
296 * @return handle to cancel the operation, NULL on error
298 struct GNUNET_TRANSPORT_AddressToStringContext *
299 GNUNET_TRANSPORT_address_to_string (const struct GNUNET_CONFIGURATION_Handle
301 const struct GNUNET_HELLO_Address *address,
303 struct GNUNET_TIME_Relative timeout,
304 GNUNET_TRANSPORT_AddressToStringCallback
305 aluc, void *aluc_cls);
309 * Cancel request for address conversion.
311 * @param alc handle for the request to cancel
314 GNUNET_TRANSPORT_address_to_string_cancel (struct
315 GNUNET_TRANSPORT_AddressToStringContext
320 * Return all the known addresses for a specific peer or all peers.
321 * Returns continuously all address if one_shot is set to GNUNET_NO
323 * CHANGE: Returns the address(es) that we are currently using for this
324 * peer. Upon completion, the 'AddressLookUpCallback' is called one more
325 * time with 'NULL' for the address and the peer. After this, the operation must no
326 * longer be explicitly cancelled.
328 * @param cfg configuration to use
329 * @param peer peer identity to look up the addresses of, CHANGE: allow NULL for all (connected) peers
330 * @param one_shot GNUNET_YES to return the current state and then end (with NULL+NULL),
331 * GNUNET_NO to monitor the set of addresses used (continuously, must be explicitly canceled, NOT implemented yet!)
332 * @param timeout how long is the lookup allowed to take at most
333 * @param peer_address_callback function to call with the results
334 * @param peer_address_callback_cls closure for peer_address_callback
336 struct GNUNET_TRANSPORT_PeerIterateContext *
337 GNUNET_TRANSPORT_peer_get_active_addresses (const struct
338 GNUNET_CONFIGURATION_Handle *cfg,
339 const struct GNUNET_PeerIdentity
341 struct GNUNET_TIME_Relative timeout,
342 GNUNET_TRANSPORT_PeerIterateCallback
343 peer_address_callback,
344 void *peer_address_callback_cls);
348 * Cancel request for peer lookup.
350 * @param alc handle for the request to cancel
353 GNUNET_TRANSPORT_peer_get_active_addresses_cancel (struct
354 GNUNET_TRANSPORT_PeerIterateContext
359 * Handle for blacklisting peers.
361 struct GNUNET_TRANSPORT_Blacklist;
365 * Function that decides if a connection is acceptable or not.
368 * @param pid peer to approve or disapproave
369 * @return GNUNET_OK if the connection is allowed, GNUNET_SYSERR if not
371 typedef int (*GNUNET_TRANSPORT_BlacklistCallback) (void *cls,
373 GNUNET_PeerIdentity * pid);
377 * Install a blacklist callback. The service will be queried for all
378 * existing connections as well as any fresh connections to check if
379 * they are permitted. If the blacklisting callback is unregistered,
380 * all hosts that were denied in the past will automatically be
381 * whitelisted again. Cancelling the blacklist handle is also the
382 * only way to re-enable connections from peers that were previously
385 * @param cfg configuration to use
386 * @param cb callback to invoke to check if connections are allowed
387 * @param cb_cls closure for cb
388 * @return NULL on error, otherwise handle for cancellation
390 struct GNUNET_TRANSPORT_Blacklist *
391 GNUNET_TRANSPORT_blacklist (const struct GNUNET_CONFIGURATION_Handle *cfg,
392 GNUNET_TRANSPORT_BlacklistCallback cb,
397 * Abort the blacklist. Note that this function is the only way for
398 * removing a peer from the blacklist.
400 * @param br handle of the request that is to be cancelled
403 GNUNET_TRANSPORT_blacklist_cancel (struct GNUNET_TRANSPORT_Blacklist *br);
407 #if 0 /* keep Emacsens' auto-indent happy */
414 /* ifndef GNUNET_TRANSPORT_SERVICE_H */
416 /* end of gnunet_transport_service.h */