X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_mesh_service.h;h=b71c055b597a7057e6698748cdb544026a4a871a;hb=6b2fb63de633b086a91e7733ca0dd5591198c20c;hp=1ff5e3becf081e2f89630c5f0ae0162d382f9fd9;hpb=02530f44ebadfe7c7758cdbad94d7fcddf28827f;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_mesh_service.h b/src/include/gnunet_mesh_service.h index 1ff5e3bec..b71c055b5 100644 --- a/src/include/gnunet_mesh_service.h +++ b/src/include/gnunet_mesh_service.h @@ -56,22 +56,26 @@ struct GNUNET_MESH_Tunnel; /** * Functions with this signature are called whenever a message is - * received or transmitted. + * 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_MessageHeader *message, - const struct GNUNET_TRANSPORT_ATS_Information *atsi); +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); /** @@ -100,47 +104,77 @@ struct GNUNET_MESH_MessageHandler }; +/** + * 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. + * 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. * * @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 + * @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); +typedef void (GNUNET_MESH_TunnelEndHandler) (void *cls, + const struct GNUNET_MESH_Tunnel * + tunnel, void *tunnel_ctx); /** - * Connect to the mesh service. + * 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 cls closure for the various callbacks that follow (including handlers in the handlers array) + * @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 * @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) - * @return handle to the mesh service - * NULL on error (in this case, init is never called) + * 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, - void *cls, - GNUNET_MESH_TunnelEndHandler cleaner, - const struct GNUNET_MESH_MessageHandler *handlers); - - -/** - * 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 - */ -const struct GNUNET_PeerIdentity* -GNUNET_MESH_get_peer(const struct GNUNET_MESH_Tunnel* tunnel); + 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); /** @@ -148,140 +182,102 @@ GNUNET_MESH_get_peer(const struct GNUNET_MESH_Tunnel* tunnel); * * @param handle connection to mesh to disconnect */ -void GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle); - - - +void +GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle); /** - * Method called whenever a tunnel falls apart. + * 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_TunnelDisconnectHandler) (void *cls, - const struct GNUNET_PeerIdentity *peer); +typedef void (*GNUNET_MESH_PeerDisconnectHandler) (void *cls, + const struct + GNUNET_PeerIdentity * peer); /** - * Method called whenever a tunnel is established. + * 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_TunnelConnectHandler) (void *cls, - const struct GNUNET_PeerIdentity *peer, - const struct GNUNET_TRANSPORT_ATS_Information *atsi); - +typedef void (*GNUNET_MESH_PeerConnectHandler) (void *cls, + const struct GNUNET_PeerIdentity + * peer, + const struct + GNUNET_ATS_Information * atsi); -/** - * 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). - */ -struct GNUNET_MESH_PeerRequestHandle; - /** - * Request that the mesh should try to connect to any of the given peers. + * Create a new tunnel (we're initiator and will be allowed to add/remove peers + * and to broadcast). * * @param h mesh handle - * @param timeout how long to try to establish a connection - * @param num_peers length of the peers arrray - * @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 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_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); - +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); /** - * Request that the mesh should try to connect to all of the given peers. - * Messages send to the tunnel will be broadcast. + * Destroy an existing tunnel. * - * @param h mesh handle - * @param timeout how long to try to establish a connection - * @param num_peers length of the peers arrray - * @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 tunnel tunnel handle */ -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_tunnel_destroy (struct GNUNET_MESH_Tunnel *tunnel); /** - * Request that a peer should be added to the tunnel. The existing - * connect handler will be called ONCE with either success or failure. + * 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 timeout how long to try to establish a connection * @param peer peer to add */ void GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel, - struct GNUNET_TIME_Relative timeout, - const struct GNUNET_PeerIdentity *peer); + const struct GNUNET_PeerIdentity *peer); /** - * Request that the mesh should try to connect to a peer supporting the given - * message type. + * Request that a peer should be removed from the tunnel. The existing + * disconnect handler will be called ONCE if we were connected. * - * @param h mesh handle - * @param timeout how long to try to establish a connection - * @param message_type message 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 tunnel handle to existing tunnel + * @param peer peer to remove */ -struct GNUNET_MESH_Tunnel * -GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Handle *h, - struct GNUNET_TIME_Relative timeout, - uint16_t message_type, - GNUNET_MESH_TunnelConnectHandler connect_handler, - GNUNET_MESH_TunnelDisconnectHandler disconnect_handler, - void *handler_cls); +void +GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel, + const struct GNUNET_PeerIdentity *peer); /** - * Cancel a pending request to connect to a particular peer. Destroys the - * tunnel. + * Request that the mesh should try to connect to a peer supporting the given + * message type. * - * @param req request handle that was returned for the original request + * @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_cancel (struct GNUNET_MESH_Tunnel *req); +GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel, + GNUNET_MESH_ApplicationType app_type); /** @@ -292,14 +288,14 @@ struct GNUNET_MESH_TransmitHandle; /** * 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. + * 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 @@ -311,20 +307,13 @@ struct GNUNET_MESH_TransmitHandle; * 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, - size_t - notify_size, - GNUNET_CONNECTION_TransmitReadyNotify - notify, - void - *notify_cls); +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); /** @@ -337,6 +326,19 @@ 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