/*
This file is part of GNUnet.
- (C) 2009, 2010, 2011, 2012, 2013 Christian Grothoff (and other contributing authors)
+ (C) 2009 - 2013 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
/**
* @file include/gnunet_mesh_service.h
- * @brief mesh service; establish tunnels to distant peers
+ * @brief mesh service; establish channels to distant peers
* @author Christian Grothoff
- *
- * TODO:
- * - need to do sanity check that this is consistent
- * with current ideas for the multicast layer's needs
*/
#ifndef GNUNET_MESH_SERVICE_H
/**
* Version number of GNUnet-mesh API.
*/
-#define GNUNET_MESH_VERSION 0x00000001
+#define GNUNET_MESH_VERSION 0x00000003
/**
struct GNUNET_MESH_Handle;
/**
- * Opaque handle to a tunnel.
+ * Opaque handle to a channel.
*/
-struct GNUNET_MESH_Tunnel;
+struct GNUNET_MESH_Channel;
+
+
+/**
+ * Channel options.
+ * Second line indicates filed in the MeshChannelInfo union carrying the answer.
+ */
+enum GNUNET_MESH_ChannelOption
+{
+ /**
+ * Default options: unreliable, default buffering, not out of order.
+ */
+ GNUNET_MESH_OPTION_DEFAULT = 0x0,
+
+ /**
+ * Disable buffering on intermediate nodes (for minimum latency).
+ * Yes/No.
+ */
+ GNUNET_MESH_OPTION_NOBUFFER = 0x1,
+
+ /**
+ * Enable channel reliability, lost messages will be retransmitted.
+ * Yes/No.
+ */
+ GNUNET_MESH_OPTION_RELIABLE = 0x2,
+
+ /**
+ * Enable out of order delivery of messages.
+ * Yes/No.
+ */
+ GNUNET_MESH_OPTION_OOORDER = 0x4,
+
+ /**
+ * Who is the peer at the other end of the channel.
+ * Only for use in @c GNUNET_MESH_channel_get_info
+ * struct GNUNET_PeerIdentity *peer
+ */
+ GNUNET_MESH_OPTION_PEER = 0x8
+
+};
/**
* Functions with this signature are called whenever a message is
* received.
- *
- * Each time the function must call GNUNET_MESH_receive_done on the tunnel
+ *
+ * Each time the function must call #GNUNET_MESH_receive_done on the channel
* in order to receive the next message. This doesn't need to be immediate:
* can be delayed if some processing is done on the message.
*
- * @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 cls Closure (set from #GNUNET_MESH_connect).
+ * @param channel Connection to the other end.
+ * @param channel_ctx Place to store local state associated with the channel.
* @param message The actual message.
- *
- * @return GNUNET_OK to keep the tunnel open,
- * GNUNET_SYSERR to close it (signal serious error).
+ * @return #GNUNET_OK to keep the channel open,
+ * #GNUNET_SYSERR to close it (signal serious error).
*/
typedef int (*GNUNET_MESH_MessageCallback) (void *cls,
- struct GNUNET_MESH_Tunnel *tunnel,
- void **tunnel_ctx,
+ struct GNUNET_MESH_Channel *channel,
+ void **channel_ctx,
const struct GNUNET_MessageHeader *message);
/**
- * Method called whenever another peer has added us to a tunnel
+ * Method called whenever another peer has added us to a channel
* the other peer initiated.
* Only called (once) upon reception of data with a message type which was
- * subscribed to in GNUNET_MESH_connect. A call to GNUNET_MESH_tunnel_destroy
- * causes te tunnel to be ignored and no further notifications are sent about
- * the same tunnel.
+ * subscribed to in #GNUNET_MESH_connect.
+ *
+ * A call to #GNUNET_MESH_channel_destroy causes te channel to be ignored. In
+ * this case the handler MUST return NULL.
*
* @param cls closure
- * @param tunnel new handle to the tunnel
- * @param initiator peer that started the tunnel
- * @param port Port this tunnel is for.
- * @return initial tunnel context for the tunnel
+ * @param channel new handle to the channel
+ * @param initiator peer that started the channel
+ * @param port Port this channel is for.
+ * @param options MeshOption flag field, with all active option bits set to 1.
+ *
+ * @return initial channel context for the channel
* (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,
- uint32_t port);
+typedef void *(GNUNET_MESH_InboundChannelNotificationHandler) (void *cls,
+ struct
+ GNUNET_MESH_Channel
+ * channel,
+ const struct
+ GNUNET_PeerIdentity
+ * initiator,
+ uint32_t port,
+ enum GNUNET_MESH_ChannelOption
+ options);
/**
- * Function called whenever a tunnel is destroyed. Should clean up
- * any associated state.
- *
- * 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
+ * Function called whenever a channel is destroyed. Should clean up
+ * any associated state.
+ *
+ * It must NOT call #GNUNET_MESH_channel_destroy on the channel.
+ *
+ * @param cls closure (set from #GNUNET_MESH_connect)
+ * @param channel connection to the other end (henceforth invalid)
+ * @param channel_ctx place where local state associated
+ * with the channel is stored
*/
-typedef void (GNUNET_MESH_TunnelEndHandler) (void *cls,
- const struct GNUNET_MESH_Tunnel *
- tunnel, void *tunnel_ctx);
+typedef void (GNUNET_MESH_ChannelEndHandler) (void *cls,
+ const struct GNUNET_MESH_Channel *
+ channel,
+ void *channel_ctx);
/**
* Connect to the mesh service.
*
* @param cfg Configuration to use.
- * @param cls Closure for the various callbacks that follow (including
+ * @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.
- * Can be NULL if no inbound tunnels are desired.
- * @param cleaner Function called when a tunnel is destroyed by the remote peer.
- * It is NOT called if GNUNET_MESH_tunnel_destroy is called on
- * the tunnel.
+ * @param new_channel Function called when an *incoming* channel is created.
+ * Can be NULL if no inbound channels are desired.
+ * See @a ports.
+ * @param cleaner Function called when a channel is destroyed by the remote peer.
+ * It is NOT called if #GNUNET_MESH_channel_destroy is called on
+ * the channel.
* @param handlers Callbacks for messages we care about, NULL-terminated. Each
- * one must call GNUNET_MESH_receive_done on the tunnel to
+ * one must call #GNUNET_MESH_receive_done on the channel to
* receive the next message. Messages of a type that is not
- * in the handlers array are ignored if received.
- * @param ports NULL or 0-terminated array of port numbers for incoming tunnels.
- *
+ * in the handlers array are ignored if received.
+ * @param ports NULL or 0-terminated array of port numbers for incoming channels.
+ * See @a new_channel.
+ *
* @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, void *cls,
- GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
- GNUNET_MESH_TunnelEndHandler cleaner,
+ GNUNET_MESH_InboundChannelNotificationHandler new_channel,
+ GNUNET_MESH_ChannelEndHandler cleaner,
const struct GNUNET_MESH_MessageHandler *handlers,
const uint32_t *ports);
/**
- * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel
+ * Disconnect from the mesh service. All channels will be destroyed. All channel
* 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.
+ * about their disconnection. The registered inbound channel cleaner will be
+ * called should any inbound channels still exist.
*
* @param handle connection to mesh to disconnect
*/
/**
- * Create a new tunnel (we're initiator and will be allowed to add/remove peers
- * and to broadcast).
+ * Create a new channel towards a remote peer.
+ *
+ * If the destination port is not open by any peer or the destination peer
+ * does not accept the channel, #GNUNET_MESH_ChannelEndHandler will be called
+ * for this channel.
*
* @param h mesh handle
- * @param tunnel_ctx client's tunnel context to associate with the tunnel
- * @param peer peer identity the tunnel should go to
+ * @param channel_ctx client's channel context to associate with the channel
+ * @param peer peer identity the channel should go to
* @param port Port number.
- * @return handle to the tunnel
+ * @param options MeshOption flag field, with all desired option bits set to 1.
+ *
+ * @return handle to the channel
*/
-struct GNUNET_MESH_Tunnel *
-GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h,
- void *tunnel_ctx,
- const struct GNUNET_PeerIdentity *peer,
- uint32_t port);
+struct GNUNET_MESH_Channel *
+GNUNET_MESH_channel_create (struct GNUNET_MESH_Handle *h,
+ void *channel_ctx,
+ const struct GNUNET_PeerIdentity *peer,
+ uint32_t port,
+ enum GNUNET_MESH_ChannelOption options);
/**
- * Destroy an existing tunnel.
- *
- * The existing end callback for the tunnel will be called immediately.
+ * Destroy an existing channel.
+ *
+ * The existing end callback for the channel will be called immediately.
* Any pending outgoing messages will be sent but no incoming messages will be
* accepted and no data callbacks will be called.
*
- * @param tunnel Tunnel handle, becomes invalid after this call.
+ * @param channel Channel handle, becomes invalid after this call.
*/
void
-GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel);
+GNUNET_MESH_channel_destroy (struct GNUNET_MESH_Channel *channel);
/**
- * Turn on/off the buffering status of the tunnel.
- *
- * @param tunnel Tunnel affected.
- * @param buffer GNUNET_YES to turn buffering on (default),
- * GNUNET_NO otherwise.
+ * Struct to retrieve info about a channel.
*/
-void
-GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer);
+union GNUNET_MESH_ChannelInfo
+{
+
+ /**
+ * #GNUNET_YES / #GNUNET_NO, for binary flags.
+ */
+ int yes_no;
+
+ /**
+ * Peer on the other side of the channel
+ */
+ const struct GNUNET_PeerIdentity peer;
+};
/**
- * Turn on/off the reliability of the tunnel.
- *
- * If reliability is on, mesh will resend lost messages, similar to TCP.
- * If reliability is off, mesh just do best effort, similar to UDP.
- *
- * @param tunnel Tunnel affected.
- * @param reliable GNUNET_YES to turn reliability on,
- * GNUNET_NO to have a best effort tunnel (default).
+ * Get information about a channel.
+ *
+ * @param channel Channel handle.
+ * @param option Query type GNUNET_MESH_OPTION_*
+ * @param ... dependant on option, currently not used
+ * @return Union with an answer to the query.
*/
-void
-GNUNET_MESH_tunnel_reliable (struct GNUNET_MESH_Tunnel *tunnel, int reliable);
+const union GNUNET_MESH_ChannelInfo *
+GNUNET_MESH_channel_get_info (struct GNUNET_MESH_Channel *channel,
+ enum GNUNET_MESH_ChannelOption option, ...);
/**
/**
- * Ask the mesh to call "notify" once it is ready to transmit the
- * given number of bytes to the specified tunnel.
+ * Ask the mesh to call @a notify once it is ready to transmit the
+ * given number of bytes to the specified channel.
* Only one call can be active at any time, to issue another request,
* wait for the callback or cancel the current request.
*
- * @param tunnel tunnel to use for transmission
+ * @param channel channel to use for transmission
* @param cork is corking allowed for this transmission?
* @param maxdelay how long can the message wait?
* @param notify_size how many bytes of buffer space does notify want?
* 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
+ * @param notify_cls closure for @a 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.
+ * memory); if NULL is returned, @a notify will NOT be called.
*/
struct GNUNET_MESH_TransmitHandle *
-GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork,
+GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Channel *channel,
+ int cork,
struct GNUNET_TIME_Relative maxdelay,
size_t notify_size,
GNUNET_CONNECTION_TransmitReadyNotify notify,
/**
- * Indicate readiness to receive the next message on a tunnel.
- *
+ * Indicate readiness to receive the next message on a channel.
+ *
* Should only be called once per handler called.
*
- * @param tunnel Tunnel that will be allowed to call another handler.
+ * @param channel Channel that will be allowed to call another handler.
*/
void
-GNUNET_MESH_receive_done (struct GNUNET_MESH_Tunnel *tunnel);
+GNUNET_MESH_receive_done (struct GNUNET_MESH_Channel *channel);
/******************************************************************************/
/**
- * Method called to retrieve information about each tunnel the mesh peer
+ * Method called to retrieve information about each channel the mesh peer
* is aware of.
*
* @param cls Closure.
- * @param tunnel_number Tunnel number.
- * @param origin that started the tunnel (owner).
- * @param target other endpoint of the tunnel
+ * @param channel_number Channel number.
+ * @param origin that started the channel (owner).
+ * @param target other endpoint of the channel
*/
-typedef void (*GNUNET_MESH_TunnelsCB) (void *cls,
- uint32_t tunnel_number,
- const struct GNUNET_PeerIdentity *origin,
- const struct GNUNET_PeerIdentity *target);
+typedef void (*GNUNET_MESH_ChannelsCB) (void *cls,
+ uint32_t root_channel_number,
+ uint32_t dest_channel_number,
+ uint32_t public_channel_number,
+ const struct GNUNET_PeerIdentity *origin,
+ const struct GNUNET_PeerIdentity *target);
/**
- * Method called to retrieve information about a specific tunnel the mesh peer
+ * Method called to retrieve information about a specific channel the mesh peer
* is aware of, including all transit nodes.
*
* @param cls Closure.
- * @param peer Peer in the tunnel's tree.
+ * @param peer Peer in the channel's tree.
* @param parent Parent of the current peer. All 0 when peer is root.
*/
-typedef void (*GNUNET_MESH_TunnelCB) (void *cls,
+typedef void (*GNUNET_MESH_ChannelCB) (void *cls,
const struct GNUNET_PeerIdentity *peer,
const struct GNUNET_PeerIdentity *parent);
+/**
+ * Method called to retrieve information about all tunnels in MESH, called
+ * once per tunnel.
+ *
+ * After last tunnel has been reported, an additional call with NULL is done.
+ *
+ * @param cls Closure.
+ * @param peer Destination peer, or NULL on "EOF".
+ * @param channels Number of channels.
+ * @param connections Number of connections.
+ * @param estate Encryption state.
+ * @param cstate Connectivity state.
+ */
+typedef void (*GNUNET_MESH_TunnelsCB) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ unsigned int channels,
+ unsigned int connections,
+ uint16_t estate,
+ uint16_t cstate);
+
+
+
+/**
+ * Method called to retrieve information about a specific tunnel the mesh peer
+ * has established, o`r is trying to establish.
+ *
+ * @param cls Closure.
+ * @param peer Peer towards whom the tunnel is directed.
+ * @param channels Number of channels.
+ * @param connections Number of connections.
+ * @param estate Encryption state.
+ * @param cstate Connectivity state.
+ */
+typedef void (*GNUNET_MESH_TunnelCB) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ unsigned int channels,
+ unsigned int connections,
+ unsigned int estate,
+ unsigned int cstate);
+
+
/**
* Request information about the running mesh peer.
- * The callback will be called for every tunnel known to the service,
- * listing all active peers that belong to the tunnel.
+ * The callback will be called for every channel known to the service,
+ * listing all active peers that belong to the channel.
*
* If called again on the same handle, it will overwrite the previous
* callback and cls. To retrieve the cls, monitor_cancel must be
* @param callback_cls Closure for @c callback.
*/
void
-GNUNET_MESH_get_tunnels (struct GNUNET_MESH_Handle *h,
- GNUNET_MESH_TunnelsCB callback,
- void *callback_cls);
+GNUNET_MESH_get_channels (struct GNUNET_MESH_Handle *h,
+ GNUNET_MESH_ChannelsCB callback,
+ void *callback_cls);
/**
- * Request information about a specific tunnel of the running mesh peer.
+ * Request information about a specific channel of the running mesh peer.
*
* WARNING: unstable API, likely to change in the future!
*
* @param h Handle to the mesh peer.
- * @param initiator ID of the owner of the tunnel.
- * @param tunnel_number Tunnel number.
+ * @param peer ID of the other end of the channel.
+ * @param channel_number Channel number.
* @param callback Function to call with the requested data.
* @param callback_cls Closure for @c callback.
*/
void
-GNUNET_MESH_show_tunnel (struct GNUNET_MESH_Handle *h,
- struct GNUNET_PeerIdentity *initiator,
- uint32_t tunnel_number,
- GNUNET_MESH_TunnelCB callback,
+GNUNET_MESH_get_channel (struct GNUNET_MESH_Handle *h,
+ struct GNUNET_PeerIdentity *peer,
+ uint32_t channel_number,
+ GNUNET_MESH_ChannelCB callback,
void *callback_cls);
* @return Closure given to GNUNET_MESH_monitor, if any.
*/
void *
+GNUNET_MESH_get_channels_cancel (struct GNUNET_MESH_Handle *h);
+
+
+/**
+ * Request information about the running mesh peer.
+ * The callback will be called for every channel known to the service,
+ * listing all active peers that blong to the channel.
+ *
+ * If called again on the same handle, it will overwrite the previous
+ * callback and cls. To retrieve the cls, monitor_cancel must be
+ * called first.
+ *
+ * WARNING: unstable API, likely to change in the future!
+ *
+ * @param h Handle to the mesh peer.
+ * @param callback Function to call with the requested data.
+ * @param callback_cls Closure for @c callback.
+ */
+void
+GNUNET_MESH_get_tunnels (struct GNUNET_MESH_Handle *h,
+ GNUNET_MESH_TunnelsCB callback,
+ void *callback_cls);
+
+/**
+ * Cancel a monitor request. The monitor callback will not be called.
+ *
+ * @param h Mesh handle.
+ *
+ * @return Closure given to GNUNET_MESH_monitor, if any.
+ */
+void *
GNUNET_MESH_get_tunnels_cancel (struct GNUNET_MESH_Handle *h);
+/**
+ * Request information about the running mesh peer.
+ * The callback will be called for every channel known to the service,
+ * listing all active peers that blong to the channel.
+ *
+ * If called again on the same handle, it will overwrite the previous
+ * callback and cls. To retrieve the cls, monitor_cancel must be
+ * called first.
+ *
+ * WARNING: unstable API, likely to change in the future!
+ *
+ * @param h Handle to the mesh peer.
+ * @param callback Function to call with the requested data.
+ * @param callback_cls Closure for @c callback.
+ */
+void
+GNUNET_MESH_get_tunnel (struct GNUNET_MESH_Handle *h,
+ const struct GNUNET_PeerIdentity *id,
+ GNUNET_MESH_TunnelCB callback,
+ void *callback_cls);
/**
- * Create a message queue for a mesh tunnel.
+ * Create a message queue for a mesh channel.
* The message queue can only be used to transmit messages,
* not to receive them.
*
- * @param tunnel the tunnel to create the message qeue for
- * @return a message queue to messages over the tunnel
+ * @param channel the channel to create the message qeue for
+ * @return a message queue to messages over the channel
*/
struct GNUNET_MQ_Handle *
-GNUNET_MESH_mq_create (struct GNUNET_MESH_Tunnel *tunnel);
+GNUNET_MESH_mq_create (struct GNUNET_MESH_Channel *channel);
#if 0 /* keep Emacsens' auto-indent happy */
projects / oweals / gnunet.git / blobdiff