X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Finclude%2Fgnunet_mesh_service.h;h=b9f0e49c6ce387f027385ec1c80fabd1f60a1ad8;hb=db3b3123f9d157c71d8b3d9e3b1d5966fe471599;hp=aefdd209a28cd44394bc747d28274f5a3e414b00;hpb=bacb370f3e767d8751cfc6bf5979fc362067c4d2;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_mesh_service.h b/src/include/gnunet_mesh_service.h index aefdd209a..b9f0e49c6 100644 --- a/src/include/gnunet_mesh_service.h +++ b/src/include/gnunet_mesh_service.h @@ -56,7 +56,7 @@ 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 @@ -67,13 +67,15 @@ struct GNUNET_MESH_Tunnel; * @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_PeerIdentity *sender, - 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); /** @@ -102,152 +104,216 @@ struct GNUNET_MESH_MessageHandler }; +/** + * 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 + * @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. 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 + * @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); + + +/** + * Type for an application. Values defined in gnunet_applications.h */ -typedef void (GNUNET_MESH_TunnelEndHandler)(void *cls, - const struct GNUNET_MESH_Tunnel *tunnel, - void **tunnel_ctx); +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 cleaner function called when an *inbound* tunnel is destroyed + * @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) - * @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); +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, + const GNUNET_MESH_ApplicationType *stypes); /** - * 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); - - -/** - * Disconnect from the mesh service. + * Disconnect from the mesh service. All tunnels will be destroyed. All tunnel + * 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. * * @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). + * Announce to ther peer the availability of services described by the regex, + * in order to be reachable to other peers via connect_by_string. + * + * Note that the first GNUNET_REGEX_INITIAL_BYTES characters are considered + * to be part of a prefix, (for instance 'gnunet://'). + * If you put a variable part in there (*, +. ()), all matching strings + * will be stored in the DHT. + * + * @param h Handle to mesh. + * @param regex String with the regular expression describing local services. + * @param compression_characters How many characters can be assigned to one + * edge of the graph. The bigger the variability + * of the data, the smaller this parameter should + * be (down to 1). + * For maximum compression, use strlen (regex) + * or 0 (special value). Use with care! */ -struct GNUNET_MESH_PeerRequestHandle; +void +GNUNET_MESH_announce_regex (struct GNUNET_MESH_Handle *h, + const char *regex, + unsigned int compression_characters); /** - * 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 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 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. The existing callback for the tunnel will NOT + * be called. * - * @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 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 the tunnel data rate is limited to the speed of the slowest + * receiver. + * + * @param tunnel Tunnel affected. + */ +void +GNUNET_MESH_tunnel_speed_min (struct GNUNET_MESH_Tunnel *tunnel); + + +/** + * Request that the tunnel data rate is limited to the speed of the fastest + * receiver. This is the default behavior. + * + * @param tunnel Tunnel affected. + */ +void +GNUNET_MESH_tunnel_speed_max (struct GNUNET_MESH_Tunnel *tunnel); + + +/** + * 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. + */ +void +GNUNET_MESH_tunnel_buffer (struct GNUNET_MESH_Tunnel *tunnel, int buffer); + + +/** + * 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); /** @@ -259,43 +325,59 @@ GNUNET_MESH_peer_request_connect_add (struct GNUNET_MESH_Tunnel *tunnel, */ void GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel, - 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. * - * @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 app_type application type that must be supported by the peer + * (MESH should discover peer in proximity handling this type) */ -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_by_type (struct GNUNET_MESH_Tunnel *tunnel, + GNUNET_MESH_ApplicationType app_type); + + +/** + * 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); /** - * Cancel a pending request to connect to a particular peer. Destroys the - * tunnel. + * Request that the given peer isn't added to this tunnel in calls to + * connect_by_* calls, (due to misbehaviour, bad performance, ...). * - * @param req request handle that was returned for the original request + * @param tunnel handle to existing tunnel. + * @param peer peer identity of the peer which should be blacklisted + * for the tunnel. */ void -GNUNET_MESH_peer_request_connect_cancel (struct GNUNET_MESH_Tunnel *req); +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 handle to existing tunnel. + * @param peer peer identity of the peer which shouldn't be blacklisted + * for the tunnel anymore. + */ +void +GNUNET_MESH_peer_unblacklist (struct GNUNET_MESH_Tunnel *tunnel, + const struct GNUNET_PeerIdentity *peer); /** @@ -306,15 +388,15 @@ 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. + * 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 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 @@ -326,21 +408,12 @@ 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, - const struct GNUNET_PeerIdentity *target, - size_t - notify_size, - GNUNET_CONNECTION_TransmitReadyNotify - notify, - void - *notify_cls); +GNUNET_MESH_notify_transmit_ready (struct GNUNET_MESH_Tunnel *tunnel, int cork, + struct GNUNET_TIME_Relative maxdelay, + const struct GNUNET_PeerIdentity *target, + size_t notify_size, + GNUNET_CONNECTION_TransmitReadyNotify notify, + void *notify_cls); /** @@ -353,6 +426,23 @@ GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle *th); +/** + * Transition API for tunnel ctx management + * + * FIXME deprecated + */ +void +GNUNET_MESH_tunnel_set_data (struct GNUNET_MESH_Tunnel *tunnel, void *data); + +/** + * Transition API for tunnel ctx management + * + * FIXME deprecated + */ +void * +GNUNET_MESH_tunnel_get_data (struct GNUNET_MESH_Tunnel *tunnel); + + #if 0 /* keep Emacsens' auto-indent happy */ { #endif