/**
* Version number of GNUnet-mesh API.
*/
-#define GNUNET_MESH_VERSION 0x00000001
+#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.
- *
- * 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 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 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).
+ *
+ * @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,
* 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
+ * 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.
*
* (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,
/**
* Function called whenever a tunnel is destroyed. Should clean up
- * any associated state.
- *
- * It must NOT call GNUNET_MESH_tunnel_destroy on the tunnel.
+ * 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
* 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.
+ * @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
+ * 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
+ * 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.
+ * 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, void *cls,
+GNUNET_MESH_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ void *cls,
GNUNET_MESH_InboundTunnelNotificationHandler new_tunnel,
GNUNET_MESH_TunnelEndHandler cleaner,
const struct GNUNET_MESH_MessageHandler *handlers,
* @param tunnel_ctx client's tunnel context to associate with the tunnel
* @param peer peer identity the tunnel should go to
* @param port Port number.
- * @param buffer Flag for buffering on relay nodes.
+ * @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,
+GNUNET_MESH_tunnel_create (struct GNUNET_MESH_Handle *h,
void *tunnel_ctx,
const struct GNUNET_PeerIdentity *peer,
uint32_t port,
- int buffer,
+ int nobuffer,
int reliable);
/**
* Destroy an existing tunnel.
- *
+ *
* 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.
/**
* Struct to retrieve info about a tunnel.
*/
-struct MeshTunnelInfo {
+union GNUNET_MESH_TunnelInfo
+{
/**
- * Property, as listed in src/mesh/mesh.h (GNUNET_MESH_OPTION_*)
+ * #GNUNET_YES / #GNUNET_NO, for binary flags.
*/
- unsigned int prop;
+ int yes_no;
/**
- * Value, of type dependant on @c prop.
+ * Peer on the other side of the tunnel
*/
- void *value;
+ const struct GNUNET_PeerIdentity peer;
};
* Get information about a tunnel.
*
* @param tunnel Tunnel handle.
- *
- * @return Allocated, {0, NULL} terminated set of tunnel properties.
+ * @param option Query, as listed in src/mesh/mesh.h (GNUNET_MESH_OPTION_*)
+ * @param ... dependant on option, currently not used
+ *
+ * @return Union with an answer to the query.
*/
-struct MeshTunnelInfo *
-GNUNET_MESH_tunnel_get_info (struct GNUNET_MESH_Tunnel *tunnel);
+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
+ * 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 maxdelay how long can the message wait?
- * @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.
/**
* 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.
* @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 @c callback.
+ * @param callback_cls Closure for @a callback.
*/
void
GNUNET_MESH_show_tunnel (struct GNUNET_MESH_Handle *h,
* 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 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);
projects / oweals / gnunet.git / blobdiff