--- /dev/null
+/*
+ This file is part of GNUnet.
+ (C) 2009, 2010 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
+ by the Free Software Foundation; either version 3, or (at your
+ option) any later version.
+
+ GNUnet is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with GNUnet; see the file COPYING. If not, write to the
+ Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ Boston, MA 02111-1307, USA.
+*/
+
+/**
+ * @file include/gnunet_mesh_service.h
+ * @brief mesh service; establish tunnels to distant peers
+ * @author Christian Grothoff
+ */
+
+#ifndef GNUNET_MESH_SERVICE_H
+#define GNUNET_MESH_SERVICE_H
+
+#ifdef __cplusplus
+extern "C"
+{
+#if 0 /* keep Emacsens' auto-indent happy */
+}
+#endif
+#endif
+
+#include "gnunet_util_lib.h"
+#include "gnunet_transport_service.h"
+
+/**
+ * Version number of GNUnet-mesh API.
+ */
+#define GNUNET_MESH_VERSION 0x00000000
+
+
+/**
+ * Opaque handle to the service.
+ */
+struct GNUNET_MESH_Handle;
+
+/**
+ * Opaque handle to a tunnel.
+ */
+struct GNUNET_MESH_Tunnel;
+
+/**
+ * Functions with this signature are called whenever a message is
+ * received or transmitted.
+ *
+ * @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_PeerIdentity *sender,
+ const struct GNUNET_MessageHeader *message,
+ const struct GNUNET_TRANSPORT_ATS_Information *atsi);
+
+
+/**
+ * Message handler. Each struct specifies how to handle on particular
+ * type of message received.
+ */
+struct GNUNET_MESH_MessageHandler
+{
+ /**
+ * Function to call for messages of "type".
+ */
+ GNUNET_MESH_MessageCallback callback;
+
+ /**
+ * Type of the message this handler covers.
+ */
+ uint16_t type;
+
+ /**
+ * Expected size of messages of this type. Use 0 for variable-size.
+ * If non-zero, messages of the given type will be discarded if they
+ * do not have the right size.
+ */
+ uint16_t expected_size;
+
+};
+
+
+/**
+ * Function called whenever an inbound tunnel is destroyed. Should clean up
+ * any associated state.
+ *
+ * @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
+ */
+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 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 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)
+ */
+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,
+ const GNUNET_MESH_ApplicationType *stypes);
+
+/**
+ * Get the peer on the other side of this tunnel if it is just one. Return NULL otherwise
+ *
+ * @deprecated
+ * @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.
+ *
+ * @param handle connection to mesh to disconnect
+ */
+void GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
+
+
+/**
+ * Method called whenever a tunnel falls apart.
+ *
+ * @param cls closure
+ * @param peer peer identity the tunnel stopped working with
+ */
+typedef void (*GNUNET_MESH_TunnelDisconnectHandler) (void *cls,
+ const struct GNUNET_PeerIdentity *peer);
+
+
+/**
+ * Method called whenever a tunnel is established.
+ *
+ * @param cls closure
+ * @param peer peer identity the tunnel was created to, NULL on timeout
+ * @param atsi performance data for the connection
+ */
+typedef void (*GNUNET_MESH_TunnelConnectHandler) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_TRANSPORT_ATS_Information *atsi);
+
+
+
+/**
+ * Create a new tunnel (we're initiator and will be allowed to add/remove peers and
+ * to broadcast).
+ *
+ * @param h mesh handle
+ * @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_tunnel_create (struct GNUNET_MESH_Handle *h,
+ GNUNET_MESH_TunnelConnectHandler connect_handler,
+ GNUNET_MESH_TunnelDisconnectHandler disconnect_handler,
+ void *handler_cls);
+
+/**
+ * Destroy an existing tunnel.
+ *
+ * @param tun tunnel handle
+ */
+void
+GNUNET_MESH_tunnel_destroy (struct GNUNET_MESH_Tunnel *tun);
+
+
+/**
+ * Request that a peer should be added to the tunnel. The existing
+ * connect handler will be called ONCE with either success or failure.
+ *
+ * @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);
+
+
+/**
+ * Request that a peer should be removed from the tunnel. The existing
+ * disconnect handler will be called ONCE if we were connected.
+ *
+ * @param tunnel handle to existing tunnel
+ * @param peer peer to remove
+ */
+void
+GNUNET_MESH_peer_request_connect_del (struct GNUNET_MESH_Tunnel *tunnel,
+ const struct GNUNET_PeerIdentity *peer);
+
+
+/**
+ * Request that the mesh should try to connect to a peer supporting the given
+ * message type.
+ *
+ * @param tunnel handle to existing tunnel
+ * @param timeout how long to try to establish a connection
+ * @param app_type application type that must be supported by the peer (MESH should
+ * discover peer in proximity handling this type)
+ * @return NULL on error (handler will not be called), otherwise handle for cancellation
+ */
+struct GNUNET_MESH_Tunnel *
+GNUNET_MESH_peer_request_connect_by_type (struct GNUNET_MESH_Tunnel *tunnel,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_MESH_ApplicationType app_type);
+
+
+/**
+ * Handle for a transmission request.
+ */
+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.
+ *
+ * @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
+ * for this peer is larger than queue_size and this is currently
+ * the message with the lowest priority
+ * @param notify_cls closure for 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);
+
+
+/**
+ * Cancel the specified transmission-ready notification.
+ *
+ * @param th handle that was returned by "notify_transmit_ready".
+ */
+void
+GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
+ *th);
+
+
+#if 0 /* keep Emacsens' auto-indent happy */
+{
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+/* ifndef GNUNET_MESH_SERVICE_H */
+#endif
+/* end of gnunet_mesh_service.h */
#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.h"
struct GNUNET_MessageHeader header;
/**
- * Id of the tunnel this path belongs to, unique in conjunction with the origin.
+ * (global) Id of the tunnel this path belongs to, unique in conjunction with the origin.
*/
uint32_t tid GNUNET_PACKED;
*/
uint32_t speed_min GNUNET_PACKED;
+ /**
+ * 64-bit alignment.
+ */
+ uint32_t reserved GNUNET_PACKED;
+
/**
* path_length structs defining the *whole* path from the origin [0] to the
* final destination [path_length-1].
*/
struct GNUNET_PeerIdentity oid;
- /**
- * FIXME: Some form of authentication
- */
- // uint32_t token;
-
/**
* Payload follows
*/
*/
struct GNUNET_PeerIdentity destination;
- /**
- * FIXME: Some form of authentication
- */
- // uint32_t token;
-
/**
* Payload follows
*/
*/
struct GNUNET_PeerIdentity sender;
- /**
- * FIXME: Some form of authentication
- */
- // uint32_t token;
-
/**
* Payload follows
*/
/**
* ID of the peer
*/
- struct GNUNET_PeerIdentity id;
+ GNUNET_PEER_Id id;
/**
* Is the peer reachable? Is the peer even connected?
enum PeerState state;
/**
- * Who to send the data to
+ * Who to send the data to --- what about multiple (alternate) paths?
*/
- uint32_t first_hop;
+ GNUNET_PEER_Id first_hop;
/**
* Max data rate to this peer
/**
* List of all the peers that form the path from origin to target
*/
- struct PeerInfo *peers;
+ GNUNET_PEER_Id *peers;
};
/**
*/
struct MESH_tunnel
{
+
+ struct MESH_tunnel *next;
+
+ struct MESH_tunnel *prev;
+
/**
* Origin ID: Node that created the tunnel
*/
- struct GNUNET_PeerIdentity oid;
+ GNUNET_PEER_Id oid;
/**
* Tunnel number (unique for a given oid)
uint32_t tid;
/**
- * Whether the tunnel is in state to transmit data
+ * Whether the tunnel is in a state to transmit data
*/
int ready;
struct Path *paths;
/**
- * Messages ready to transmit
+ * Messages ready to transmit??? -- real queues needed
*/
struct GNUNET_MessageHeader *msg_out;
/**
- * Messages received and not processed
+ * Messages received and not processed??? -- real queues needed
*/
struct GNUNET_MessageHeader *msg_in;
/**
- * FIXME Clients. Is anyone to be notified for traffic here?
+ * If this tunnel was created by a local client, what's its handle?
*/
+ struct GNUNET_SERVER_Client *initiator;
};
/**
* So, I'm an endpoint. Why am I receiveing traffic?
* Who is interested in this? How to communicate with them?
*/
-struct Clients
+struct Client
{
+
+ struct Client *next;
+
+ struct Client *prev;
+
+ struct MESH_tunnel *my_tunnels_head;
+
+ struct MESH_tunnel *my_tunnels_tail;
+
/**
- * FIXME add structures needed to handle client connections
+ * If this tunnel was created by a local client, what's its handle?
*/
- int fixme;
+ struct GNUNET_SERVER_Client *handle;
+
+ unsigned int messages_subscribed_counter;
+
+ uint16_t *messages_subscribed;
+
};
+static struct MESH_tunnel *tunnel_participation_head;
+
+static struct MESH_tunnel *tunnel_participation_tail;
+
+
/******************************************************************************/
/******************** MESH NETWORK HANDLERS **************************/
const struct GNUNET_TRANSPORT_ATS_Information
*atsi)
{
+ /*
+ * EXAMPLE OF USING THE API
+ * NOT ACTUAL CODE!!!!!
+ */
+ /*client *c;
+ tunnel *t;
+
+ t = new;
+ GNUNET_CONTAINER_DLL_insert (c->my_tunnels_head,
+ c->my_tunnels_tail,
+ t);
+
+ while (NULL != (t = c->my_tunnels_head))
+ {
+ GNUNET_CONTAINER_DLL_remove (c->my_tunnels_head,
+ c->my_tunnels_tail,
+ t);
+ GNUNET_free (t);
+ }
+ */
+
+
/* Extract path */
/* Find origin & self */
/* Search for origin in local tunnels */
{&handle_local_connect, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_ADD, 0},
{&handle_local_connect, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_DEL, 0},
{&handle_local_connect, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE, sizeof(struct GNUNET_MESH_ConnectPeerByType)},
- {&handle_local_connect, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_CANCEL, sizeof(struct GNUNET_MESH_Control)},
- {&handle_local_network_traffic, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_TRANSMIT_READY, sizeof(struct GNUNET_MESH_Control)},
+ {&handle_local_connect, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_CANCEL, 0},
+ {&handle_local_network_traffic, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_TRANSMIT_READY, 0},
{&handle_local_network_traffic, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA, 0}, /* FIXME needed? */
{&handle_local_network_traffic, NULL, GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA_BROADCAST, 0}, /* FIXME needed? */
{NULL, NULL, 0, 0}
"mesh",
GNUNET_SERVICE_OPTION_NONE, &run, NULL)) ? 0 : 1;
return ret;
-}
\ No newline at end of file
+}
/* API CALL MESSAGE USED
* -------- ------------
* connect GNUNET_MESH_Connect
- * disconnect Server_disconnect
+ * disconnect None (network level disconnect)
+ *
+ * tunnel_create GNUNET_MESH_TunnelMessage
+ * tunnel_destroy GNUNET_MESH_TunnelMessage
*
- * peer_request_connect_any GNUNET_MESH_ConnectPeer
- * peer_request_connect_all GNUNET_MESH_ConnectPeer
* peer_request_connect_add GNUNET_MESH_ConnectPeer
* peer_request_connect_del GNUNET_MESH_ConnectPeer
* peer_request_connect_by_type GNUNET_MESH_ConnectPeerByType
- * peer_request_connect_cancel GNUNET_MESH_Control
*
* notify_transmit_ready GNUNET_MESH_Control
* notify_transmit_ready_cancel None
*/
+
struct GNUNET_MESH_Connect {
/**
* Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT
/* uint16_t messages_subscribed[] */
};
-struct GNUNET_MESH_ConnectPeer {
+
+/**
+ *
+ */
+struct GNUNET_MESH_TunnelMessage {
/**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ANY|ALL|ADD|DEL]
- *
- * Size: sizeof(struct GNUNET_MESH_ConnectPeer) + npeers * sizeof (struct GNUNET_PeerIdentity)
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATE|DESTROY]
*/
struct GNUNET_MessageHeader header;
- /* struct GNUNET_PeerIdentity peers[] */
+ /**
+ * ID of a tunnel controlled by this client.
+ */
+ uint32_t tunnel_id GNUNET_PACKED;
};
+
+struct GNUNET_MESH_PeerControl {
+
+ /**
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_[ADD|DEL] (client to service, client created tunnel)
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_NOTIFY[CONNECT|DISCONNECT] (service to client)
+ *
+ * Size: sizeof(struct GNUNET_MESH_PeerControl)
+ */
+ struct GNUNET_MessageHeader header;
+
+ /**
+ * ID of a tunnel controlled by this client.
+ */
+ uint32_t tunnel_id GNUNET_PACKED;
+
+ /**
+ * Peer to connect/disconnect.
+ */
+ struct GNUNET_PeerIdentity peer;
+};
+
+
+
+
struct GNUNET_MESH_ConnectPeerByType {
/**
* Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_BY_TYPE
*/
struct GNUNET_MessageHeader header;
- /* Type specification */
+ /**
+ * ID of a tunnel controlled by this client.
+ */
+ uint32_t tunnel_id GNUNET_PACKED;
+
+ /**
+ * Type specification
+ */
GNUNET_MESH_ApplicationType type;
};
-struct GNUNET_MESH_Control {
+
+struct GNUNET_MESH_RequestTransmitReady {
/**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_CONNECT_PEER_CANCEL
- * GNUNET_MESSAGE_TYPE_MESH_LOCAL_TRANSMIT_READY
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_REQUEST_TRANSMIT_READY
*/
struct GNUNET_MessageHeader header;
+ /**
+ * ID of a tunnel controlled by this client.
+ */
uint32_t tunnel_id GNUNET_PACKED;
- uint32_t variable GNUNET_PACKED; /* Size of data / connection ID */
+
+ /**
+ * Size of message we would like to transmit to this tunnel
+ */
+ uint32_t msg_size GNUNET_PACKED;
};
-struct GNUNET_MESH_TunnelEvent {
+struct GNUNET_MESH_NotifyTransmitReady {
/**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_TUNNEL_[CREATED\DESTROYED]
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_NOTIFY_TRANSMIT_READY
*/
struct GNUNET_MessageHeader header;
+ /**
+ * ID of a tunnel controlled by this client.
+ */
uint32_t tunnel_id GNUNET_PACKED;
- uint32_t reason GNUNET_PACKED; /* incoming, connect, timeout, disconnect */
+
+ /**
+ * Size of message we can now transmit to this tunnel
+ */
+ uint32_t msg_size GNUNET_PACKED;
};
+
struct GNUNET_MESH_Data {
/**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA (client to service, or service to client)
*
* Size: sizeof(struct GNUNET_MESH_Data) + sizeof (data)
*/
struct GNUNET_MessageHeader header;
+ /**
+ * ID of a tunnel controlled by this client.
+ */
uint32_t tunnel_id GNUNET_PACKED;
+ /**
+ * Source or destination of the message (depending on direction).
+ */
struct GNUNET_PeerIdentity destination;
/* uint8_t data[] */
};
+
struct GNUNET_MESH_DataBroadcast {
/**
- * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA_BROADCAST
+ * Type: GNUNET_MESSAGE_TYPE_MESH_LOCAL_DATA_BROADCAST (client to service only, client created tunnel)
*
* Size: sizeof(struct GNUNET_MESH_DataBroadcast) + sizeof (data)
*/
struct GNUNET_MessageHeader header;
+ /**
+ * ID of a tunnel controlled by this client.
+ */
uint32_t tunnel_id GNUNET_PACKED;
/* uint8_t data[] */
};
+
#endif
projects / oweals / gnunet.git / commitdiff