/usr/include/gnunet/gnunet_mesh_service.h is in gnunet-dev 0.9.3-7build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 | /*
This file is part of GNUnet.
(C) 2009, 2010 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @file include/gnunet_mesh_service.h
* @brief mesh service; establish tunnels to distant peers
* @author Christian Grothoff
*/
#ifndef GNUNET_MESH_SERVICE_H
#define GNUNET_MESH_SERVICE_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "gnunet_util_lib.h"
#include "gnunet_transport_service.h"
/**
* Version number of GNUnet-mesh API.
*/
#define GNUNET_MESH_VERSION 0x00000000
/**
* Opaque handle to the service.
*/
struct GNUNET_MESH_Handle;
/**
* Opaque handle to a tunnel.
*/
struct GNUNET_MESH_Tunnel;
/**
* Functions with this signature are called whenever a message is
* received.
*
* @param cls closure (set from GNUNET_MESH_connect)
* @param tunnel connection to the other end
* @param tunnel_ctx place to store local state associated with the tunnel
* @param sender who sent the message
* @param message the actual message
* @param atsi performance data for the connection
* @return GNUNET_OK to keep the connection open,
* GNUNET_SYSERR to close it (signal serious error)
*/
typedef int (*GNUNET_MESH_MessageCallback) (void *cls,
struct GNUNET_MESH_Tunnel * tunnel,
void **tunnel_ctx,
const struct GNUNET_PeerIdentity *
sender,
const struct GNUNET_MessageHeader *
message,
const struct GNUNET_ATS_Information
* atsi);
/**
* Message handler. Each struct specifies how to handle on particular
* type of message received.
*/
struct GNUNET_MESH_MessageHandler
{
/**
* Function to call for messages of "type".
*/
GNUNET_MESH_MessageCallback callback;
/**
* Type of the message this handler covers.
*/
uint16_t type;
/**
* Expected size of messages of this type. Use 0 for variable-size.
* If non-zero, messages of the given type will be discarded if they
* do not have the right size.
*/
uint16_t expected_size;
};
/**
* Method called whenever another peer has added us to a tunnel
* the other peer initiated.
*
* @param cls closure
* @param tunnel new handle to the tunnel
* @param initiator peer that started the tunnel
* @param atsi performance information for the tunnel
* @return initial tunnel context for the tunnel
* (can be NULL -- that's not an error)
*/
typedef void *(GNUNET_MESH_InboundTunnelNotificationHandler) (void *cls,
struct
GNUNET_MESH_Tunnel
* tunnel,
const struct
GNUNET_PeerIdentity
* initiator,
const struct
GNUNET_ATS_Information
* atsi);
/**
* Function called whenever an inbound tunnel is destroyed. Should clean up
* any associated state. This function is NOT called if the client has
* explicitly asked for the tunnel to be destroyed using
* GNUNET_MESH_tunnel_destroy. It must NOT call GNUNET_MESH_tunnel_destroy on
* the tunnel.
*
* @param cls closure (set from GNUNET_MESH_connect)
* @param tunnel connection to the other end (henceforth invalid)
* @param tunnel_ctx place where local state associated
* with the tunnel is stored
*/
typedef void (GNUNET_MESH_TunnelEndHandler) (void *cls,
const struct GNUNET_MESH_Tunnel *
tunnel, void *tunnel_ctx);
/**
* Type for an application. Values defined in gnunet_applications.h
*/
typedef uint32_t GNUNET_MESH_ApplicationType;
/**
* Connect to the mesh service.
*
* @param cfg configuration to use
* @param queue_size size of the data message queue, shared among all tunnels
* (each tunnel is guaranteed to accept at least one message,
* no matter what is the status of other tunnels)
* @param cls closure for the various callbacks that follow
* (including handlers in the handlers array)
* @param new_tunnel function called when an *inbound* tunnel is created
* @param cleaner function called when an *inbound* tunnel is destroyed by the
* remote peer, it is *not* called if GNUNET_MESH_tunnel_destroy
* is called on the tunnel
* @param handlers callbacks for messages we care about, NULL-terminated
* note that the mesh is allowed to drop notifications about
* inbound messages if the client does not process them fast
* enough (for this notification type, a bounded queue is used)
* @param stypes list of the applications that this client claims to provide
* @return handle to the mesh service NULL on error
* (in this case, init is never called)
*/
struct GNUNET_MESH_Handle *
GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
unsigned int queue_size, void *cls,
GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
GNUNET_MESH_TunnelEndHandler cleaner,
const struct GNUNET_MESH_MessageHandler *handlers,
const GNUNET_MESH_ApplicationType *stypes);
/**
* Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
* disconnect callbacks will be called on any still connected peers, notifying
* about their disconnection. The registered inbound tunnel cleaner will be
* called should any inbound tunnels still exist.
*
* @param handle connection to mesh to disconnect
*/
void
GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
/**
* Method called whenever a peer has disconnected from the tunnel.
* Implementations of this callback must NOT call
* GNUNET_MESH_tunnel_destroy immediately, but instead schedule those
* to run in some other task later. However, calling
* "GNUNET_MESH_notify_transmit_ready_cancel" is allowed.
*
* @param cls closure
* @param peer peer identity the tunnel stopped working with
*/
typedef void (*GNUNET_MESH_PeerDisconnectHandler) (void *cls,
const struct
GNUNET_PeerIdentity * peer);
/**
* Method called whenever a peer has connected to the tunnel.
*
* @param cls closure
* @param peer peer identity the tunnel was created to, NULL on timeout
* @param atsi performance data for the connection
*
* TODO: change to return int to let client allow the new peer or not?
*/
typedef void (*GNUNET_MESH_PeerConnectHandler) (void *cls,
const struct GNUNET_PeerIdentity
* peer,
const struct
GNUNET_ATS_Information * atsi);
/**
* Create a new tunnel (we're initiator and will be allowed to add/remove peers
* and to broadcast).
*
* @param h mesh handle
* @param tunnel_ctx client's tunnel context to associate with the tunnel
* @param connect_handler function to call when peers are actually connected
* @param disconnect_handler function to call when peers are disconnected
* @param handler_cls closure for connect/disconnect handlers
*/
struct GNUNET_MESH_Tunnel *
GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h, void *tunnel_ctx,
GNUNET_MESH_PeerConnectHandler connect_handler,
GNUNET_MESH_PeerDisconnectHandler disconnect_handler,
void *handler_cls);
/**
* Destroy an existing tunnel. The existing callback for the tunnel will NOT
* be called.
*
* @param tunnel tunnel handle
*/
void
GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel);
/**
* Request that a peer should be added to the tunnel. The connect handler
* will be called when the peer connects
*
* @param tunnel handle to existing tunnel
* @param peer peer to add
*/
void
GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
const struct GNUNET_PeerIdentity *peer);
/**
* Request that a peer should be removed from the tunnel. The existing
* disconnect handler will be called ONCE if we were connected.
*
* @param tunnel handle to existing tunnel
* @param peer peer to remove
*/
void
GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
const struct GNUNET_PeerIdentity *peer);
/**
* Request that the mesh should try to connect to a peer supporting the given
* message type.
*
* @param tunnel handle to existing tunnel
* @param app_type application type that must be supported by the peer
* (MESH should discover peer in proximity handling this type)
*/
void
GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
GNUNET_MESH_ApplicationType app_type);
/**
* Handle for a transmission request.
*/
struct GNUNET_MESH_TransmitHandle;
/**
* Ask the mesh to call "notify" once it is ready to transmit the
* given number of bytes to the specified tunnel or target.
*
* @param tunnel tunnel to use for transmission
* @param cork is corking allowed for this transmission?
* @param priority how important is the message?
* @param maxdelay how long can the message wait?
* @param target destination for the message
* NULL for multicast to all tunnel targets
* @param notify_size how many bytes of buffer space does notify want?
* @param notify function to call when buffer space is available;
* will be called with NULL on timeout or if the overall queue
* for this peer is larger than queue_size and this is currently
* the message with the lowest priority
* @param notify_cls closure for notify
* @return non-NULL if the notify callback was queued,
* NULL if we can not even queue the request (insufficient
* memory); if NULL is returned, "notify" will NOT be called.
*/
struct GNUNET_MESH_TransmitHandle *
GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
uint32_t priority,
struct GNUNET_TIME_Relative maxdelay,
const struct GNUNET_PeerIdentity *target,
size_t notify_size,
GNUNET_CONNECTION_TransmitReadyNotify notify,
void *notify_cls);
/**
* Cancel the specified transmission-ready notification.
*
* @param th handle that was returned by "notify_transmit_ready".
*/
void
GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
*th);
/**
* Transition API for tunnel ctx management
*/
void
GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data);
/**
* Transition API for tunnel ctx management
*/
void *
GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef GNUNET_MESH_SERVICE_H */
#endif
/* end of gnunet_mesh_service.h */
|