/*
This file is part of GNUnet.
- (C) 2009, 2010 Christian Grothoff (and other contributing authors)
+ (C) 2009, 2010, 2011, 2012, 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
* @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 0x00000000
+#define GNUNET_MESH_VERSION 0x00000002
/**
*/
struct GNUNET_MESH_Tunnel;
+
+/**
+ * Options for querying a tunnel.
+ * Second line indicates filed in the MeshTunnelInfo union carrying the answer.
+ */
+enum MeshTunnelOption
+{
+ /**
+ * Disable buffering on intermediate nodes (for minimum latency).
+ * Yes/No.
+ */
+ GNUNET_MESH_OPTION_NOBUFFER = 0x1,
+
+ /**
+ * Enable tunnel 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 tunnel.
+ * struct GNUNET_PeerIdentity *peer
+ */
+ GNUNET_MESH_OPTION_PEER = 0x8
+
+};
+
+
/**
* 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)
+ * Each time the function must call #GNUNET_MESH_receive_done on the tunnel
+ * 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 message The actual message.
+ *
+ * @return #GNUNET_OK to keep the tunnel open,
+ * #GNUNET_SYSERR to close it (signal serious error).
*/
typedef int (*GNUNET_MESH_MessageCallback) (void *cls,
- struct GNUNET_MESH_Tunnel * tunnel,
+ struct GNUNET_MESH_Tunnel *tunnel,
void **tunnel_ctx,
- const struct GNUNET_PeerIdentity *
- sender,
- const struct GNUNET_MessageHeader *
- message,
- const struct GNUNET_ATS_Information
- * atsi);
+ const struct GNUNET_MessageHeader *message);
/**
* 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.
+ * 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.
*
* @param cls closure
* @param tunnel new handle to the tunnel
* @param initiator peer that started the tunnel
- * @param atsi performance information for the tunnel
+ * @param port Port this tunnel is for.
* @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,
+ struct GNUNET_MESH_Tunnel *tunnel,
const struct
GNUNET_PeerIdentity
* initiator,
- const struct
- GNUNET_ATS_Information
- * atsi);
+ uint32_t port);
/**
- * 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.
+ * 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 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
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
+ * @param cfg Configuration to use.
+ * @param cls Closure for the various callbacks that follow (including
+ * handlers in the handlers array).
+ * @param new_tunnel Function called when an *incoming* tunnel is created.
+ * Can be NULL if no inbound tunnels are desired.
+ * See @c ports.
+ * @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 handlers Callbacks for messages we care about, NULL-terminated. Each
+ * one must call #GNUNET_MESH_receive_done on the tunnel 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.
+ * See @c new_tunnel.
+ *
* @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,
+ void *cls,
GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
GNUNET_MESH_TunnelEndHandler cleaner,
const struct GNUNET_MESH_MessageHandler *handlers,
- const GNUNET_MESH_ApplicationType *stypes);
+ const uint32_t *ports);
/**
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);
-
-
-/**
- * Announce to ther peer the availability of services described by the regex,
- * in order to be reachable to other peers via connect_by_string.
- *
- * @param h handle to mesh.
- * @param regex string with the regular expression describing local services.
- */
-void
-GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h,
- const char *regex);
-
-
/**
* 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
+ * @param peer peer identity the tunnel should go to
+ * @param port Port number.
+ * @param nobuffer Flag for disabling buffering on relay nodes.
+ * @param reliable Flag for end-to-end reliability.
+ * @return handle to the tunnel
*/
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);
+GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h,
+ void *tunnel_ctx,
+ const struct GNUNET_PeerIdentity *peer,
+ uint32_t port,
+ int nobuffer,
+ int reliable);
/**
- * Request that a peer should be added to the tunnel. The connect handler
- * will be called when the peer connects
+ * Destroy an existing tunnel.
*
- * @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.
+ * The existing end callback for the tunnel 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 handle to existing tunnel
- * @param peer peer to remove
+ * @param tunnel Tunnel handle, becomes invalid after this call.
*/
void
-GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
- const struct GNUNET_PeerIdentity *peer);
+GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel);
/**
- * 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)
+ * Struct to retrieve info about a tunnel.
*/
-void
-GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
- GNUNET_MESH_ApplicationType app_type);
+union GNUNET_MESH_TunnelInfo
+{
+ /**
+ * #GNUNET_YES / #GNUNET_NO, for binary flags.
+ */
+ int yes_no;
-/**
- * Request that the mesh should try to connect to a peer matching the
- * description given in the service string.
- *
- * @param tunnel handle to existing tunnel
- * @param description string describing the destination node requirements
- */
-void
-GNUNET_MESH_peer_request_connect_by_string (struct GNUNET_MESH_Tunnel *tunnel,
- const char *description);
+ /**
+ * Peer on the other side of the tunnel
+ */
+ const struct GNUNET_PeerIdentity peer;
+};
/**
- * Request that the given peer isn't added to this tunnel in calls to
- * connect_by_* calls, (due to misbehaviour, bad performance, ...).
+ * Get information about a tunnel.
*
- * @param tunnel handle to existing tunnel.
- * @param peer peer identity of the peer which should be blacklisted
- * for the tunnel.
- */
-void
-GNUNET_MESH_peer_blacklist (struct GNUNET_MESH_Tunnel *tunnel,
- const struct GNUNET_PeerIdentity *peer);
-
-
-/**
- * Request that the given peer isn't blacklisted anymore from this tunnel,
- * and therefore can be added in future calls to connect_by_*.
- * The peer must have been previously blacklisted for this tunnel.
+ * @param tunnel Tunnel handle.
+ * @param option Query, as listed in src/mesh/mesh.h (GNUNET_MESH_OPTION_*)
+ * @param ... dependant on option, currently not used
*
- * @param tunnel handle to existing tunnel.
- * @param peer peer identity of the peer which shouldn't be blacklisted
- * for the tunnel anymore.
+ * @return Union with an answer to the query.
*/
-void
-GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel,
- const struct GNUNET_PeerIdentity *peer);
+const union GNUNET_MESH_TunnelInfo *
+GNUNET_MESH_tunnel_get_info (struct GNUNET_MESH_Tunnel *tunnel,
+ enum MeshTunnelOption option, ...);
/**
/**
- * Ask the mesh to call "notify" once it is ready to transmit the
- * given number of bytes to the specified tunnel or target.
+ * Ask the mesh to call @a notify once it is ready to transmit the
+ * given number of bytes to the specified tunnel.
+ * 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 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_size how many bytes of buffer space does @a 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
+ * @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.
*/
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);
/**
- * Transition API for tunnel ctx management
+ * Indicate readiness to receive the next message on a tunnel.
+ *
+ * Should only be called once per handler called.
+ *
+ * @param tunnel Tunnel that will be allowed to call another handler.
+ */
+void
+GNUNET_MESH_receive_done (struct GNUNET_MESH_Tunnel *tunnel);
+
+
+
+/******************************************************************************/
+/******************** 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. */
+/******************************************************************************/
+
+/**
+ * Method called to retrieve information about each tunnel 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
+ */
+typedef void (*GNUNET_MESH_TunnelsCB) (void *cls,
+ uint32_t tunnel_number,
+ const struct GNUNET_PeerIdentity *origin,
+ const struct GNUNET_PeerIdentity *target);
+
+
+/**
+ * Method called to retrieve information about a specific tunnel the mesh peer
+ * is aware of, including all transit nodes.
+ *
+ * @param cls Closure.
+ * @param peer Peer in the tunnel's tree.
+ * @param parent Parent of the current peer. All 0 when peer is root.
+ */
+typedef void (*GNUNET_MESH_TunnelCB) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_PeerIdentity *parent);
+
+
+/**
+ * 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.
+ *
+ * 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_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data);
+GNUNET_MESH_get_tunnels (struct GNUNET_MESH_Handle *h,
+ GNUNET_MESH_TunnelsCB callback,
+ void *callback_cls);
+
/**
- * Transition API for tunnel ctx management
+ * Request information about a specific tunnel 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 callback Function to call with the requested data.
+ * @param callback_cls Closure for @a callback.
+ */
+void
+GNUNET_MESH_show_tunnel (struct GNUNET_MESH_Handle *h,
+ struct GNUNET_PeerIdentity *initiator,
+ uint32_t tunnel_number,
+ GNUNET_MESH_TunnelCB callback,
+ void *callback_cls);
+
+
+/**
+ * Cancel a monitor request. The monitor callback 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.
*/
void *
-GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel);
+GNUNET_MESH_get_tunnels_cancel (struct GNUNET_MESH_Handle *h);
+
+
+/**
+ * Create a message queue for a mesh tunnel.
+ * The message queue can only be used to transmit messages,
+ * not to receive them.
+ *
+ * @param tunnel the tunnel to create the message queue for
+ * @return a message queue for sending messages over the tunnel
+ */
+struct GNUNET_MQ_Handle *
+GNUNET_MESH_mq_create (struct GNUNET_MESH_Tunnel *tunnel);
#if 0 /* keep Emacsens' auto-indent happy */
projects / oweals / gnunet.git / blobdiff