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
59 * received or transmitted.
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)
71 (*GNUNET_MESH_MessageCallback) (void *cls,
72 struct GNUNET_MESH_Tunnel *tunnel,
74 const struct GNUNET_PeerIdentity *sender,
75 const struct GNUNET_MessageHeader *message,
76 const struct GNUNET_TRANSPORT_ATS_Information *atsi);
80 * Message handler. Each struct specifies how to handle on particular
81 * type of message received.
83 struct GNUNET_MESH_MessageHandler
86 * Function to call for messages of "type".
88 GNUNET_MESH_MessageCallback callback;
91 * Type of the message this handler covers.
96 * Expected size of messages of this type. Use 0 for variable-size.
97 * If non-zero, messages of the given type will be discarded if they
98 * do not have the right size.
100 uint16_t expected_size;
106 * Function called whenever an inbound tunnel is destroyed. Should clean up
107 * any associated state.
109 * @param cls closure (set from GNUNET_MESH_connect)
110 * @param tunnel connection to the other end (henceforth invalid)
111 * @param tunnel_ctx place where local state associated with the tunnel is stored
113 typedef void (GNUNET_MESH_TunnelEndHandler)(void *cls,
114 const struct GNUNET_MESH_Tunnel *tunnel,
119 * Connect to the mesh service.
121 * @param cfg configuration to use
122 * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
123 * @param cleaner function called when an *inbound* tunnel is destroyed
124 * @param handlers callbacks for messages we care about, NULL-terminated
125 * note that the mesh is allowed to drop notifications about inbound
126 * messages if the client does not process them fast enough (for this
127 * notification type, a bounded queue is used)
128 * @return handle to the mesh service
129 * NULL on error (in this case, init is never called)
131 struct GNUNET_MESH_Handle *
132 GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
134 GNUNET_MESH_TunnelEndHandler cleaner,
135 const struct GNUNET_MESH_MessageHandler *handlers);
139 * Get the peer on the other side of this tunnel if it is just one. Return NULL otherwise
141 * @param tunnel the tunnel
142 * @return the peer or NULL
144 const struct GNUNET_PeerIdentity*
145 GNUNET_MESH_get_peer(const struct GNUNET_MESH_Tunnel* tunnel);
149 * Disconnect from the mesh service.
151 * @param handle connection to mesh to disconnect
153 void GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
160 * Method called whenever a tunnel falls apart.
163 * @param peer peer identity the tunnel stopped working with
165 typedef void (*GNUNET_MESH_TunnelDisconnectHandler) (void *cls,
166 const struct GNUNET_PeerIdentity *peer);
170 * Method called whenever a tunnel is established.
173 * @param peer peer identity the tunnel was created to, NULL on timeout
174 * @param atsi performance data for the connection
176 typedef void (*GNUNET_MESH_TunnelConnectHandler) (void *cls,
177 const struct GNUNET_PeerIdentity *peer,
178 const struct GNUNET_TRANSPORT_ATS_Information *atsi);
183 * Handle for a request to the mesh to connect or disconnect
184 * from a particular peer. Can be used to cancel the request
185 * (before the 'cont'inuation is called).
187 struct GNUNET_MESH_PeerRequestHandle;
191 * Request that the mesh should try to connect to any of the given peers.
193 * @param h mesh handle
194 * @param timeout how long to try to establish a connection
195 * @param num_peers length of the peers array
196 * @param peers list of candidates to connect to
197 * @param connect_handler function to call on successful connect (or timeout)
198 * @param disconnect_handler function to call on disconnect
199 * @param handler_cls closure for handler
200 * @return NULL on error (handler will not be called), otherwise handle for cancellation
202 struct GNUNET_MESH_Tunnel *
203 GNUNET_MESH_peer_request_connect_any (struct GNUNET_MESH_Handle *h,
204 struct GNUNET_TIME_Relative timeout,
205 unsigned int num_peers,
206 const struct GNUNET_PeerIdentity *peers,
207 GNUNET_MESH_TunnelConnectHandler connect_handler,
208 GNUNET_MESH_TunnelDisconnectHandler disconnect_handler,
213 * Request that the mesh should try to connect to all of the given peers.
214 * Messages send to the tunnel will be broadcast.
216 * @param h mesh handle
217 * @param timeout how long to try to establish a connection
218 * @param num_peers length of the peers array
219 * @param peers list of candidates to connect to
220 * @param connect_handler function to call on successful connect (or timeout);
221 * will be called for EACH of the peers in the list and
222 * once at the end with 'NULL' on timeout or once we've connected
223 * to each of the peers in the list
224 * @param disconnect_handler function called if a peer drops out of the tunnel;
225 * the mesh will NOT try to add it back automatically
226 * @param handler_cls closure for handler
227 * @return NULL on error (handler will not be called), otherwise handle for cancellation
229 struct GNUNET_MESH_Tunnel *
230 GNUNET_MESH_peer_request_connect_all (struct GNUNET_MESH_Handle *h,
231 struct GNUNET_TIME_Relative timeout,
232 unsigned int num_peers,
233 const struct GNUNET_PeerIdentity *peers,
234 GNUNET_MESH_TunnelConnectHandler connect_handler,
235 GNUNET_MESH_TunnelDisconnectHandler disconnect_handler,
240 * Request that a peer should be added to the tunnel. The existing
241 * connect handler will be called ONCE with either success or failure.
243 * @param tunnel handle to existing tunnel
244 * @param timeout how long to try to establish a connection
245 * @param peer peer to add
248 GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
249 struct GNUNET_TIME_Relative timeout,
250 const struct GNUNET_PeerIdentity *peer);
254 * Request that a peer should be removed from the tunnel. The existing
255 * disconnect handler will be called ONCE if we were connected.
257 * @param tunnel handle to existing tunnel
258 * @param peer peer to remove
261 GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
262 const struct GNUNET_PeerIdentity *peer);
266 * Request that the mesh should try to connect to a peer supporting the given
269 * @param h mesh handle
270 * @param timeout how long to try to establish a connection
271 * @param message_type message type that must be supported by the peer (MESH should
272 * discover peer in proximity handling this type)
273 * @param connect_handler function to call on successful connect (or timeout);
274 * will be called for EACH of the peers in the list and
275 * once at the end with 'NULL' on timeout or once we've connected
276 * to each of the peers in the list
277 * @param disconnect_handler function called if a peer drops out of the tunnel;
278 * the mesh will NOT try to add it back automatically
279 * @param handler_cls closure for handler
280 * @return NULL on error (handler will not be called), otherwise handle for cancellation
282 struct GNUNET_MESH_Tunnel *
283 GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Handle *h,
284 struct GNUNET_TIME_Relative timeout,
285 uint16_t message_type,
286 GNUNET_MESH_TunnelConnectHandler connect_handler,
287 GNUNET_MESH_TunnelDisconnectHandler disconnect_handler,
292 * Cancel a pending request to connect to a particular peer. Destroys the
295 * @param req request handle that was returned for the original request
298 GNUNET_MESH_peer_request_connect_cancel (struct GNUNET_MESH_Tunnel *req);
302 * Handle for a transmission request.
304 struct GNUNET_MESH_TransmitHandle;
308 * Ask the mesh to call "notify" once it is ready to transmit the
309 * given number of bytes to the specified "target". If we are not yet
310 * connected to the specified peer, a call to this function will cause
311 * us to try to establish a connection.
313 * @param tunnel tunnel to use for transmission
314 * @param cork is corking allowed for this transmission?
315 * @param priority how important is the message?
316 * @param maxdelay how long can the message wait?
317 * @param target destination for the message, NULL for multicast to all tunnel targets
318 * @param notify_size how many bytes of buffer space does notify want?
319 * @param notify function to call when buffer space is available;
320 * will be called with NULL on timeout or if the overall queue
321 * for this peer is larger than queue_size and this is currently
322 * the message with the lowest priority
323 * @param notify_cls closure for notify
324 * @return non-NULL if the notify callback was queued,
325 * NULL if we can not even queue the request (insufficient
326 * memory); if NULL is returned, "notify" will NOT be called.
328 struct GNUNET_MESH_TransmitHandle *
329 GNUNET_MESH_notify_transmit_ready (struct
337 // const struct GNUNET_PeerIdentity *target,
340 GNUNET_CONNECTION_TransmitReadyNotify
347 * Cancel the specified transmission-ready notification.
349 * @param th handle that was returned by "notify_transmit_ready".
352 GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
356 #if 0 /* keep Emacsens' auto-indent happy */
363 /* ifndef GNUNET_MESH_SERVICE_H */
365 /* end of gnunet_mesh_service.h */