X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Fmesh%2Fmesh.h;h=d8fc404e19462433a6a6180b523afaddb9810f5b;hb=1e1865f39492df814911c4448155df6b09ab802d;hp=57778a3527eb6240fa314db591207313774d6fac;hpb=f7c0d631f7119d27e9ddcfc0064a3cd6610ba901;p=oweals%2Fgnunet.git diff --git a/src/mesh/mesh.h b/src/mesh/mesh.h index 57778a352..d8fc404e1 100644 --- a/src/mesh/mesh.h +++ b/src/mesh/mesh.h @@ -23,104 +23,241 @@ * @file mesh/mesh.h */ - #ifndef MESH_H_ #define MESH_H_ #include +#define MESH_DEBUG GNUNET_YES + + +#include "platform.h" +#include "gnunet_common.h" +#include "gnunet_util_lib.h" +#include "gnunet_peer_lib.h" +#include "gnunet_core_service.h" +#include "gnunet_protocols.h" +#include + +/******************************************************************************/ +/******************** MESH LOCAL MESSAGES *************************/ +/******************************************************************************/ +/* Any API call should be documented in the folowing table under API CALL. + * Also, any message type should be documented in the following table, with the + * associated event. + * + * API CALL (GNUNET_MESH_*) MESSAGE USED + * ------------------------ ------------ + * connect GNUNET_MESH_ClientConnect + * disconnect None (network level disconnect) + * + * tunnel_create GNUNET_MESH_TunnelMessage + * tunnel_destroy GNUNET_MESH_TunnelMessage + * + * peer_request_connect_add GNUNET_MESH_PeerControl + * peer_request_connect_del GNUNET_MESH_PeerControl + * peer_request_connect_by_type GNUNET_MESH_ConnectPeerByType + * + * notify_transmit_ready *GNUNET_MESH_TransmitReady?* + * notify_transmit_ready_cancel None (clear of internal data structures) + * + * + * + * EVENT MESSAGE USED + * ----- ------------ + * data GNUNET_MESH_Data OR + * GNUNET_MESH_DataBroadcast + * new incoming tunnel GNUNET_MESH_PeerControl + * peer connects to a tunnel GNUNET_MESH_PeerControl + * peer disconnects from a tunnel GNUNET_MESH_PeerControl + */ + +/******************************************************************************/ +/************************** CONSTANTS ******************************/ +/******************************************************************************/ + +#define GNUNET_MESH_LOCAL_TUNNEL_ID_CLI 0x80000000 +#define GNUNET_MESH_LOCAL_TUNNEL_ID_SERV 0xB0000000 + +#define CORE_QUEUE_SIZE 10 +#define LOCAL_QUEUE_SIZE 100 + +/******************************************************************************/ +/************************** MESSAGES ******************************/ +/******************************************************************************/ + +GNUNET_NETWORK_STRUCT_BEGIN + /** - * Message for mesh path management + * Message for a client to register to the service */ -struct GNUNET_MESH_ManipulatePath +struct GNUNET_MESH_ClientConnect { /** - * Type: GNUNET_MESSAGE_TYPE_MESH_PATH_[CREATE|CHANGE|ADD] + * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT + * + * Size: sizeof(struct GNUNET_MESH_ClientConnect) + + * sizeof(MESH_ApplicationType) * applications + + * sizeof(uint16_t) * types */ - struct GNUNET_MessageHeader header; + struct GNUNET_MessageHeader header; + uint16_t applications GNUNET_PACKED; + uint16_t types GNUNET_PACKED; + /* uint16_t list_apps[applications] */ + /* uint16_t list_types[types] */ +}; - /** - * Id of the tunnel this path belongs to - */ - uint32_t tid; - /** - * Information about speed requirements - */ - uint32_t speed_min; - uint32_t speed_max; +/** + * Type for tunnel numbering. + * - Local tunnel numbers given by the service (incoming) are >= 0xB0000000 + * - Local tunnel numbers given by the client (created) are >= 0x80000000 + * - Global tunnel numbers are < 0x80000000 + */ +typedef uint32_t MESH_TunnelNumber; +/** + * Message for a client to create and destroy tunnels. + */ +struct GNUNET_MESH_TunnelMessage +{ /** - * Number of hops in the path given below + * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY] + * + * Size: sizeof(struct GNUNET_MESH_TunnelMessage) */ - uint16_t path_length; + struct GNUNET_MessageHeader header; /** - * path_length structs defining the *whole* path + * ID of a tunnel controlled by this client. */ - struct GNUNET_PeerIdentity peers[]; + MESH_TunnelNumber tunnel_id GNUNET_PACKED; }; + /** - * Message for mesh data traffic + * Message for the service to let a client know about created tunnels. */ -struct GNUNET_MESH_Data +struct GNUNET_MESH_TunnelNotification { /** - * Type: GNUNET_MESSAGE_TYPE_DATA_[GO|BACK] + * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_CREATE + * + * Size: sizeof(struct GNUNET_MESH_TunnelMessage) */ - struct GNUNET_MessageHeader header; + struct GNUNET_MessageHeader header; /** - * OID of the tunnel + * ID of a tunnel controlled by this client. */ - struct GNUNET_PeerIdentity oid; + MESH_TunnelNumber tunnel_id GNUNET_PACKED; /** - * TID of the tunnel + * Peer at the other end, if any */ - uint32_t tid; + struct GNUNET_PeerIdentity peer; +}; - /** - * Size of payload - * FIXME uint16 enough? - */ - uint16_t size; +/** + * Message for: + * - request adding and deleting peers from a tunnel + * - notify the client that peers have connected: + * -- requested + * -- unrequested (new incoming tunnels) + * - notify the client that peers have disconnected + */ +struct GNUNET_MESH_PeerControl +{ + + /** + * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL] + * (client to service, client created tunnel) + * GNUNET_MESSAGE_TYPE_MESH_LOCAL_PEER_[CONNECTED|DISCONNECTED] + * (service to client) + * + * Size: sizeof(struct GNUNET_MESH_PeerControl) + */ + struct GNUNET_MessageHeader header; + + /** + * ID of a tunnel controlled by this client. + */ + MESH_TunnelNumber tunnel_id GNUNET_PACKED; + /** + * Peer to connect/disconnect. + */ + struct GNUNET_PeerIdentity peer; +}; + + +/** + * Message for connecting to peers offering a certain service. + */ +struct GNUNET_MESH_ConnectPeerByType +{ /** - * Payload + * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE | + * GNUNET_MESSAGE_TYPE_MESH_LOCAL_DISCONNECT_PEER_BY_TYPE */ - uint8_t data[]; + struct GNUNET_MessageHeader header; + + /** + * ID of a tunnel controlled by this client. + */ + MESH_TunnelNumber tunnel_id GNUNET_PACKED; + + /** + * Type specification + */ + GNUNET_MESH_ApplicationType type GNUNET_PACKED; }; +GNUNET_NETWORK_STRUCT_END + +/******************************************************************************/ +/************************ ENUMERATIONS ****************************/ +/******************************************************************************/ /** - * Message for mesh flow control + * All the states a peer participating in a tunnel can be in. */ -struct GNUNET_MESH_SpeedNotify +enum MeshPeerState { /** - * Type: GNUNET_MESSAGE_TYPE_DATA_SPEED_NOTIFY + * Uninitialized status, should never appear in operation. + */ + MESH_PEER_INVALID, + + /** + * Peer is the root and owner of the tree */ - struct GNUNET_MessageHeader header; + MESH_PEER_ROOT, /** - * OID of the tunnel + * Peer only retransmits traffic, is not a final destination */ - struct GNUNET_PeerIdentity oid; + MESH_PEER_RELAY, /** - * TID of the tunnel + * Path to the peer not known yet */ - uint32_t tid; + MESH_PEER_SEARCHING, /** - * Slowest link down the path + * Request sent, not yet answered. */ - uint32_t speed_min; + MESH_PEER_WAITING, /** - * Fastest link down the path + * Peer connected and ready to accept data */ - uint32_t speed_max; + MESH_PEER_READY, + + /** + * Peer connected previosly but not responding + */ + MESH_PEER_RECONNECTING }; -#endif \ No newline at end of file + + +#endif