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_mesh_service.h
23 * @brief mesh service; establish tunnels to distant peers
24 * @author Christian Grothoff
27 #ifndef GNUNET_MESH_SERVICE_H
28 #define GNUNET_MESH_SERVICE_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_util_lib.h"
39 #include "gnunet_transport_service.h"
42 * Version number of GNUnet-mesh API.
44 #define GNUNET_MESH_VERSION 0x00000000
48 * Opaque handle to the service.
50 struct GNUNET_MESH_Handle;
53 * Opaque handle to a tunnel.
55 struct GNUNET_MESH_Tunnel;
58 * Functions with this signature are called whenever a message is
61 * @param cls closure (set from GNUNET_MESH_connect)
62 * @param tunnel connection to the other end
63 * @param tunnel_ctx place to store local state associated with the tunnel
64 * @param sender who sent the message
65 * @param message the actual message
66 * @param atsi performance data for the connection
67 * @return GNUNET_OK to keep the connection open,
68 * GNUNET_SYSERR to close it (signal serious error)
70 typedef int (*GNUNET_MESH_MessageCallback) (void *cls,
71 struct GNUNET_MESH_Tunnel * tunnel,
73 const struct GNUNET_PeerIdentity *
75 const struct GNUNET_MessageHeader *
77 const struct GNUNET_ATS_Information
82 * Message handler. Each struct specifies how to handle on particular
83 * type of message received.
85 struct GNUNET_MESH_MessageHandler
88 * Function to call for messages of "type".
90 GNUNET_MESH_MessageCallback callback;
93 * Type of the message this handler covers.
98 * Expected size of messages of this type. Use 0 for variable-size.
99 * If non-zero, messages of the given type will be discarded if they
100 * do not have the right size.
102 uint16_t expected_size;
108 * Method called whenever another peer has added us to a tunnel
109 * the other peer initiated.
110 * Only called (once) upon reception of data with a message type which was
111 * subscribed to in GNUNET_MESH_connect. A call to GNUNET_MESH_tunnel_destroy
112 * causes te tunnel to be ignored and no further notifications are sent about
116 * @param tunnel new handle to the tunnel
117 * @param initiator peer that started the tunnel
118 * @param atsi performance information for the tunnel
119 * @return initial tunnel context for the tunnel
120 * (can be NULL -- that's not an error)
122 typedef void *(GNUNET_MESH_InboundTunnelNotificationHandler) (void *cls,
130 GNUNET_ATS_Information
135 * Function called whenever an inbound tunnel is destroyed. Should clean up
136 * any associated state. This function is NOT called if the client has
137 * explicitly asked for the tunnel to be destroyed using
138 * GNUNET_MESH_tunnel_destroy. It must NOT call GNUNET_MESH_tunnel_destroy on
141 * @param cls closure (set from GNUNET_MESH_connect)
142 * @param tunnel connection to the other end (henceforth invalid)
143 * @param tunnel_ctx place where local state associated
144 * with the tunnel is stored
146 typedef void (GNUNET_MESH_TunnelEndHandler) (void *cls,
147 const struct GNUNET_MESH_Tunnel *
148 tunnel, void *tunnel_ctx);
152 * Type for an application. Values defined in gnunet_applications.h
154 typedef uint32_t GNUNET_MESH_ApplicationType;
158 * Connect to the mesh service.
160 * @param cfg configuration to use
161 * @param cls closure for the various callbacks that follow
162 * (including handlers in the handlers array)
163 * @param new_tunnel function called when an *inbound* tunnel is created
164 * @param cleaner function called when an *inbound* tunnel is destroyed by the
165 * remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
166 * is called on the tunnel
167 * @param handlers callbacks for messages we care about, NULL-terminated
168 * note that the mesh is allowed to drop notifications about
169 * inbound messages if the client does not process them fast
170 * enough (for this notification type, a bounded queue is used)
171 * @param stypes list of the applications that this client claims to provide
172 * @return handle to the mesh service NULL on error
173 * (in this case, init is never called)
175 struct GNUNET_MESH_Handle *
176 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
177 GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
178 GNUNET_MESH_TunnelEndHandler cleaner,
179 const struct GNUNET_MESH_MessageHandler *handlers,
180 const GNUNET_MESH_ApplicationType *stypes);
184 * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
185 * disconnect callbacks will be called on any still connected peers, notifying
186 * about their disconnection. The registered inbound tunnel cleaner will be
187 * called should any inbound tunnels still exist.
189 * @param handle connection to mesh to disconnect
192 GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
196 * Method called whenever a peer has disconnected from the tunnel.
197 * Implementations of this callback must NOT call
198 * GNUNET_MESH_tunnel_destroy immediately, but instead schedule those
199 * to run in some other task later. However, calling
200 * "GNUNET_MESH_notify_transmit_ready_cancel" is allowed.
203 * @param peer peer identity the tunnel stopped working with
205 typedef void (*GNUNET_MESH_PeerDisconnectHandler) (void *cls,
207 GNUNET_PeerIdentity * peer);
211 * Method called whenever a peer has connected to the tunnel.
214 * @param peer peer identity the tunnel was created to, NULL on timeout
215 * @param atsi performance data for the connection
217 * TODO: change to return int to let client allow the new peer or not?
219 typedef void (*GNUNET_MESH_PeerConnectHandler) (void *cls,
220 const struct GNUNET_PeerIdentity
223 GNUNET_ATS_Information * atsi);
227 * Announce to ther peer the availability of services described by the regex,
228 * in order to be reachable to other peers via connect_by_string.
230 * Note that the first GNUNET_REGEX_INITIAL_BYTES characters are considered
231 * to be part of a prefix, (for instance 'gnunet://').
232 * If you put a variable part in there (*, +. ()), all matching strings
233 * will be stored in the DHT.
235 * @param h Handle to mesh.
236 * @param regex String with the regular expression describing local services.
237 * @param compression_characters How many characters can be assigned to one
238 * edge of the graph. The bigger the variability
239 * of the data, the smaller this parameter should
241 * For maximum compression, use strlen (regex)
242 * or 0 (special value). Use with care!
245 GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
247 unsigned int compression_characters);
251 * Create a new tunnel (we're initiator and will be allowed to add/remove peers
254 * @param h mesh handle
255 * @param tunnel_ctx client's tunnel context to associate with the tunnel
256 * @param connect_handler function to call when peers are actually connected
257 * @param disconnect_handler function to call when peers are disconnected
258 * @param handler_cls closure for connect/disconnect handlers
260 struct GNUNET_MESH_Tunnel *
261 GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
262 GNUNET_MESH_PeerConnectHandler connect_handler,
263 GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
267 * Destroy an existing tunnel. The existing callback for the tunnel will NOT
270 * @param tunnel tunnel handle
273 GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel);
277 * Request that the tunnel data rate is limited to the speed of the slowest
280 * @param tunnel Tunnel affected.
283 GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel);
287 * Request that the tunnel data rate is limited to the speed of the fastest
288 * receiver. This is the default behavior.
290 * @param tunnel Tunnel affected.
293 GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel);
297 * Turn on/off the buffering status of the tunnel.
299 * @param tunnel Tunnel affected.
300 * @param buffer GNUNET_YES to turn buffering on (default),
301 * GNUNET_NO otherwise.
304 GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer);
308 * Request that a peer should be added to the tunnel. The connect handler
309 * will be called when the peer connects
311 * @param tunnel handle to existing tunnel
312 * @param peer peer to add
315 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
316 const struct GNUNET_PeerIdentity *peer);
320 * Request that a peer should be removed from the tunnel. The existing
321 * disconnect handler will be called ONCE if we were connected.
323 * @param tunnel handle to existing tunnel
324 * @param peer peer to remove
327 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
328 const struct GNUNET_PeerIdentity *peer);
332 * Request that the mesh should try to connect to a peer supporting the given
335 * @param tunnel handle to existing tunnel
336 * @param app_type application type that must be supported by the peer
337 * (MESH should discover peer in proximity handling this type)
340 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
341 GNUNET_MESH_ApplicationType app_type);
345 * Request that the mesh should try to connect to a peer matching the
346 * description given in the service string.
348 * @param tunnel handle to existing tunnel
349 * @param description string describing the destination node requirements
352 GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
353 const char *description);
357 * Request that the given peer isn't added to this tunnel in calls to
358 * connect_by_* calls, (due to misbehaviour, bad performance, ...).
360 * @param tunnel handle to existing tunnel.
361 * @param peer peer identity of the peer which should be blacklisted
365 GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
366 const struct GNUNET_PeerIdentity *peer);
370 * Request that the given peer isn't blacklisted anymore from this tunnel,
371 * and therefore can be added in future calls to connect_by_*.
372 * The peer must have been previously blacklisted for this tunnel.
374 * @param tunnel handle to existing tunnel.
375 * @param peer peer identity of the peer which shouldn't be blacklisted
376 * for the tunnel anymore.
379 GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
380 const struct GNUNET_PeerIdentity *peer);
384 * Handle for a transmission request.
386 struct GNUNET_MESH_TransmitHandle;
390 * Ask the mesh to call "notify" once it is ready to transmit the
391 * given number of bytes to the specified tunnel or target.
392 * Only one call can be active at any time, to issue another request,
393 * wait for the callback or cancel the current request.
395 * @param tunnel tunnel to use for transmission
396 * @param cork is corking allowed for this transmission?
397 * @param maxdelay how long can the message wait?
398 * @param target destination for the message
399 * NULL for multicast to all tunnel targets
400 * @param notify_size how many bytes of buffer space does notify want?
401 * @param notify function to call when buffer space is available;
402 * will be called with NULL on timeout or if the overall queue
403 * for this peer is larger than queue_size and this is currently
404 * the message with the lowest priority
405 * @param notify_cls closure for notify
406 * @return non-NULL if the notify callback was queued,
407 * NULL if we can not even queue the request (insufficient
408 * memory); if NULL is returned, "notify" will NOT be called.
410 struct GNUNET_MESH_TransmitHandle *
411 GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
412 struct GNUNET_TIME_Relative maxdelay,
413 const struct GNUNET_PeerIdentity *target,
415 GNUNET_CONNECTION_TransmitReadyNotify notify,
420 * Cancel the specified transmission-ready notification.
422 * @param th handle that was returned by "notify_transmit_ready".
425 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
430 * Method called to retrieve information about each tunnel the mesh peer
433 * @param cls Closure.
434 * @param initiator Peer that started the tunnel (owner).
435 * @param tunnel_number Tunnel number.
436 * @param peers Array of peer identities that participate in the tunnel.
437 * @param npeers Number of peers in peers.
439 typedef void (*GNUNET_MESH_TunnelsCB) (void *cls,
440 const struct GNUNET_PeerIdentity *owner,
441 unsigned int tunnel_number,
442 const struct GNUNET_PeerIdentity *peers,
443 unsigned int npeers);
447 * Method called to retrieve information about a specific tunnel the mesh peer
448 * is aware of, including all transit nodes.
450 * @param cls Closure.
451 * @param peer Peer in the tunnel's tree.
452 * @param parent Parent of the current peer. All 0 when peer is root.
454 typedef void (*GNUNET_MESH_TunnelCB) (void *cls,
455 const struct GNUNET_PeerIdentity *peer,
456 const struct GNUNET_PeerIdentity *parent);
460 * Request information about the running mesh peer.
461 * The callback will be called for every tunnel known to the service,
462 * listing all active peers that blong to the tunnel.
464 * If called again on the same handle, it will overwrite the previous
465 * callback and cls. To retrieve the cls, monitor_cancel must be
468 * WARNING: unstable API, likely to change in the future!
470 * @param h Handle to the mesh peer.
471 * @param callback Function to call with the requested data.
472 * @param callback_cls Closure for @c callback.
475 GNUNET_MESH_get_tunnels (struct GNUNET_MESH_Handle *h,
476 GNUNET_MESH_TunnelsCB callback,
481 * Request information about a specific tunnel of the running mesh peer.
483 * WARNING: unstable API, likely to change in the future!
485 * @param h Handle to the mesh peer.
486 * @param initiator ID of the owner of the tunnel.
487 * @param tunnel_number Tunnel number.
488 * @param callback Function to call with the requested data.
489 * @param callback_cls Closure for @c callback.
492 GNUNET_MESH_show_tunnel (struct GNUNET_MESH_Handle *h,
493 struct GNUNET_PeerIdentity *initiator,
494 unsigned int tunnel_number,
495 GNUNET_MESH_TunnelCB callback,
500 * Cancel a monitor request. The monitor callback will not be called.
502 * WARNING: unstable API, likely to change in the future!
504 * @param h Mesh handle.
506 * @return Closure given to GNUNET_MESH_monitor, if any.
509 GNUNET_MESH_get_tunnels_cancel (struct GNUNET_MESH_Handle *h);
513 * Transition API for tunnel ctx management
518 GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data);
521 * Transition API for tunnel ctx management
526 GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel);
529 #if 0 /* keep Emacsens' auto-indent happy */
536 /* ifndef GNUNET_MESH_SERVICE_H */
538 /* end of gnunet_mesh_service.h */