/*
This file is part of GNUnet.
- (C) 2009, 2010 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
*/
/**
* Version number of GNUnet-mesh API.
*/
-#define GNUNET_MESH_VERSION 0x00000000
+#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 or transmitted.
+ * received.
+ *
+ * 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 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)
+ * @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 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,
- const struct GNUNET_PeerIdentity *sender,
- const struct GNUNET_MessageHeader *message,
- const struct GNUNET_TRANSPORT_ATS_Information *atsi);
+typedef int (*GNUNET_MESH_MessageCallback) (void *cls,
+ struct GNUNET_MESH_Channel *channel,
+ void **channel_ctx,
+ const struct GNUNET_MessageHeader *message);
/**
* do not have the right size.
*/
uint16_t expected_size;
-
};
/**
- * Function called whenever an inbound tunnel is destroyed. Should clean up
- * any associated state.
+ * 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_channel_destroy causes te channel to be ignored. In
+ * this case the handler MUST return NULL.
+ *
+ * @param cls closure
+ * @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.
*
- * @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
+ * @return initial channel context for the channel
+ * (can be NULL -- that's not an error)
*/
-typedef void (GNUNET_MESH_TunnelEndHandler)(void *cls,
- const struct GNUNET_MESH_Tunnel *tunnel,
- void **tunnel_ctx);
+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);
/**
- * Type for an application. Values defined in gnunet_applications.h
+ * 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 uint32_t GNUNET_MESH_ApplicationType;
+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 handlers in the handlers array)
- * @param cleaner function called when an *inbound* tunnel is destroyed
- * @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 Application Types the client claims to offer
- * @return handle to the mesh service
- * NULL on error (in this case, init is never called)
+ * @param cfg Configuration to use.
+ * @param cls Closure for the various callbacks that follow (including
+ * handlers in the handlers array).
+ * @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 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 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_TunnelEndHandler cleaner,
- const struct GNUNET_MESH_MessageHandler *handlers,
- const GNUNET_MESH_ApplicationType *stypes);
+GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
+ GNUNET_MESH_InboundChannelNotificationHandler new_channel,
+ GNUNET_MESH_ChannelEndHandler cleaner,
+ const struct GNUNET_MESH_MessageHandler *handlers,
+ const uint32_t *ports);
+
/**
- * Get the peer on the other side of this tunnel if it is just one. Return NULL otherwise
- *
- * @param tunnel the tunnel
- * @return the peer or NULL
+ * 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 channel cleaner will be
+ * called should any inbound channels still exist.
+ *
+ * @param handle connection to mesh to disconnect
*/
-const struct GNUNET_PeerIdentity*
-GNUNET_MESH_get_peer(const struct GNUNET_MESH_Tunnel* tunnel);
+void
+GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
/**
- * Disconnect from the mesh service.
+ * Create a new channel towards a remote peer.
*
- * @param handle connection to mesh to disconnect
+ * 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 channel_ctx client's channel context to associate with the channel
+ * @param peer peer identity the channel should go to
+ * @param port Port number.
+ * @param options MeshOption flag field, with all desired option bits set to 1.
+ *
+ * @return handle to the channel
*/
-void GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
-
+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 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 channel Channel handle, becomes invalid after this call.
+ */
+void
+GNUNET_MESH_channel_destroy (struct GNUNET_MESH_Channel *channel);
/**
- * Method called whenever a tunnel falls apart.
- *
- * @param cls closure
- * @param peer peer identity the tunnel stopped working with
+ * Struct to retrieve info about a channel.
*/
-typedef void (*GNUNET_MESH_TunnelDisconnectHandler) (void *cls,
- const struct GNUNET_PeerIdentity *peer);
+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;
+};
/**
- * Method called whenever a tunnel is established.
+ * Get information about a channel.
*
- * @param cls closure
- * @param peer peer identity the tunnel was created to, NULL on timeout
- * @param atsi performance data for the connection
+ * @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.
*/
-typedef void (*GNUNET_MESH_TunnelConnectHandler) (void *cls,
- const struct GNUNET_PeerIdentity *peer,
- const struct GNUNET_TRANSPORT_ATS_Information *atsi);
-
+const union GNUNET_MESH_ChannelInfo *
+GNUNET_MESH_channel_get_info (struct GNUNET_MESH_Channel *channel,
+ enum GNUNET_MESH_ChannelOption option, ...);
/**
- * Handle for a request to the mesh to connect or disconnect
- * from a particular peer. Can be used to cancel the request
- * (before the 'cont'inuation is called).
+ * Handle for a transmission request.
*/
-struct GNUNET_MESH_PeerRequestHandle;
+struct GNUNET_MESH_TransmitHandle;
/**
- * Request that the mesh should try to connect to any of the given peers.
+ * 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 h mesh handle
- * @param timeout how long to try to establish a connection
- * @param num_peers length of the peers array
- * @param peers list of candidates to connect to
- * @param connect_handler function to call on successful connect (or timeout)
- * @param disconnect_handler function to call on disconnect
- * @param handler_cls closure for handler
- * @return NULL on error (handler will not be called), otherwise handle for cancellation
+ * @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?
+ * @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 @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, @a notify will NOT be called.
*/
-struct GNUNET_MESH_Tunnel *
-GNUNET_MESH_peer_request_connect_any (struct GNUNET_MESH_Handle *h,
- struct GNUNET_TIME_Relative timeout,
- unsigned int num_peers,
- const struct GNUNET_PeerIdentity *peers,
- GNUNET_MESH_TunnelConnectHandler connect_handler,
- GNUNET_MESH_TunnelDisconnectHandler disconnect_handler,
- void *handler_cls);
+struct GNUNET_MESH_TransmitHandle *
+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,
+ void *notify_cls);
/**
- * Request that the mesh should try to connect to all of the given peers.
- * Messages send to the tunnel will be broadcast.
+ * Cancel the specified transmission-ready notification.
*
- * @param h mesh handle
- * @param timeout how long to try to establish a connection
- * @param num_peers length of the peers array
- * @param peers list of candidates to connect to
- * @param connect_handler function to call on successful connect (or timeout);
- * will be called for EACH of the peers in the list and
- * once at the end with 'NULL' on timeout or once we've connected
- * to each of the peers in the list
- * @param disconnect_handler function called if a peer drops out of the tunnel;
- * the mesh will NOT try to add it back automatically
- * @param handler_cls closure for handler
- * @return NULL on error (handler will not be called), otherwise handle for cancellation
+ * @param th handle that was returned by "notify_transmit_ready".
*/
-struct GNUNET_MESH_Tunnel *
-GNUNET_MESH_peer_request_connect_all (struct GNUNET_MESH_Handle *h,
- struct GNUNET_TIME_Relative timeout,
- unsigned int num_peers,
- const struct GNUNET_PeerIdentity *peers,
- GNUNET_MESH_TunnelConnectHandler connect_handler,
- GNUNET_MESH_TunnelDisconnectHandler disconnect_handler,
- void *handler_cls);
+void
+GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
+ *th);
/**
- * Request that a peer should be added to the tunnel. The existing
- * connect handler will be called ONCE with either success or failure.
+ * Indicate readiness to receive the next message on a channel.
*
- * @param tunnel handle to existing tunnel
- * @param timeout how long to try to establish a connection
- * @param peer peer to add
+ * Should only be called once per handler called.
+ *
+ * @param channel Channel that will be allowed to call another handler.
*/
void
-GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel,
- struct GNUNET_TIME_Relative timeout,
- const struct GNUNET_PeerIdentity *peer);
+GNUNET_MESH_receive_done (struct GNUNET_MESH_Channel *channel);
+
+
+/******************************************************************************/
+/******************** MONITORING /DEBUG API *************************/
+/******************************************************************************/
+/* The following calls are not useful for normal MESH operation, but for */
+/* debug and monitoring of the mesh state. They can be safely ignored. */
+/* The API can change at any point without notice. */
+/* Please contact the developer if you consider any of this calls useful for */
+/* normal mesh applications. */
+/******************************************************************************/
/**
- * Request that a peer should be removed from the tunnel. The existing
- * disconnect handler will be called ONCE if we were connected.
+ * Method called to retrieve information about each channel the mesh peer
+ * is aware of.
*
- * @param tunnel handle to existing tunnel
- * @param peer peer to remove
+ * @param cls Closure.
+ * @param channel_number Channel number.
+ * @param origin that started the channel (owner).
+ * @param target other endpoint of the channel
*/
-void
-GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
- const struct GNUNET_PeerIdentity *peer);
+typedef void (*GNUNET_MESH_ChannelsCB) (void *cls,
+ uint32_t channel_number,
+ const struct GNUNET_PeerIdentity *origin,
+ const struct GNUNET_PeerIdentity *target);
/**
- * Request that the mesh should try to connect to a peer supporting the given
- * message type.
+ * Method called to retrieve information about a specific channel the mesh peer
+ * is aware of, including all transit nodes.
*
- * @param h mesh handle
- * @param timeout how long to try to establish a connection
- * @param app_type application type that must be supported by the peer (MESH should
- * discover peer in proximity handling this type)
- * @param connect_handler function to call on successful connect (or timeout);
- * will be called for EACH of the peers in the list and
- * once at the end with 'NULL' on timeout or once we've connected
- * to each of the peers in the list
- * @param disconnect_handler function called if a peer drops out of the tunnel;
- * the mesh will NOT try to add it back automatically
- * @param handler_cls closure for handler
- * @return NULL on error (handler will not be called), otherwise handle for cancellation
+ * @param cls Closure.
+ * @param peer Peer in the channel's tree.
+ * @param parent Parent of the current peer. All 0 when peer is root.
*/
-struct GNUNET_MESH_Tunnel *
-GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Handle *h,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_MESH_ApplicationType app_type,
- GNUNET_MESH_TunnelConnectHandler connect_handler,
- GNUNET_MESH_TunnelDisconnectHandler disconnect_handler,
- void *handler_cls);
+typedef void (*GNUNET_MESH_ChannelCB) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_PeerIdentity *parent);
/**
- * Cancel a pending request to connect to a particular peer. Destroys the
- * tunnel.
+ * Request information about the running mesh peer.
+ * 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
+ * called first.
+ *
+ * WARNING: unstable API, likely to change in the future!
*
- * @param req request handle that was returned for the original request
+ * @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_peer_request_connect_cancel (struct GNUNET_MESH_Tunnel *req);
+GNUNET_MESH_get_channels (struct GNUNET_MESH_Handle *h,
+ GNUNET_MESH_ChannelsCB callback,
+ void *callback_cls);
/**
- * Handle for a transmission request.
+ * 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 channel.
+ * @param channel_number Channel number.
+ * @param callback Function to call with the requested data.
+ * @param callback_cls Closure for @c callback.
*/
-struct GNUNET_MESH_TransmitHandle;
+void
+GNUNET_MESH_show_channel (struct GNUNET_MESH_Handle *h,
+ struct GNUNET_PeerIdentity *initiator,
+ uint32_t channel_number,
+ GNUNET_MESH_ChannelCB callback,
+ void *callback_cls);
/**
- * Ask the mesh to call "notify" once it is ready to transmit the
- * given number of bytes to the specified "target". If we are not yet
- * connected to the specified peer, a call to this function will cause
- * us to try to establish a connection.
+ * Cancel a monitor request. The monitor callback will not be called.
*
- * @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.
+ * WARNING: unstable API, likely to change in the future!
+ *
+ * @param h Mesh handle.
+ *
+ * @return Closure given to GNUNET_MESH_monitor, if any.
*/
-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);
+void *
+GNUNET_MESH_get_channels_cancel (struct GNUNET_MESH_Handle *h);
/**
- * Cancel the specified transmission-ready notification.
+ * Create a message queue for a mesh channel.
+ * The message queue can only be used to transmit messages,
+ * not to receive them.
*
- * @param th handle that was returned by "notify_transmit_ready".
+ * @param channel the channel to create the message qeue for
+ * @return a message queue to messages over the channel
*/
-void
-GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
- *th);
-
-void GNUNET_MESH_tunnel_set_head(struct GNUNET_MESH_Tunnel* tunnel, void* head);
-void GNUNET_MESH_tunnel_set_tail(struct GNUNET_MESH_Tunnel* tunnel, void* tail);
-void* GNUNET_MESH_tunnel_get_head(struct GNUNET_MESH_Tunnel* tunnel);
-void* GNUNET_MESH_tunnel_get_tail(struct GNUNET_MESH_Tunnel* tunnel);
+struct GNUNET_MQ_Handle *
+GNUNET_MESH_mq_create (struct GNUNET_MESH_Channel *channel);
-void GNUNET_MESH_tunnel_set_data(struct GNUNET_MESH_Tunnel* tunnel, void* data);
-void* GNUNET_MESH_tunnel_get_data(struct GNUNET_MESH_Tunnel* tunnel);
#if 0 /* keep Emacsens' auto-indent happy */
{
projects / oweals / gnunet.git / blobdiff