#include "gnunet_util_lib.h"
-#include "mesh_path.h"
-#include "gnunet-service-mesh_channel.h"
+
+/**
+ * All the states a connection can be in.
+ */
+enum MeshConnectionState
+{
+ /**
+ * Uninitialized status, should never appear in operation.
+ */
+ MESH_CONNECTION_NEW,
+
+ /**
+ * Connection create message sent, waiting for ACK.
+ */
+ MESH_CONNECTION_SENT,
+
+ /**
+ * Connection ACK sent, waiting for ACK.
+ */
+ MESH_CONNECTION_ACK,
+
+ /**
+ * Connection confirmed, ready to carry traffic.
+ */
+ MESH_CONNECTION_READY,
+};
/**
*/
struct MeshConnection;
+#include "mesh_path.h"
+#include "gnunet-service-mesh_channel.h"
+#include "gnunet-service-mesh_peer.h"
* Core handler for notifications of broken paths
*
* @param cls Closure (unused).
- * @param peer Peer identity of sending neighbor.
+ * @param id Peer identity of sending neighbor.
* @param message Message.
*
* @return GNUNET_OK to keep the connection open,
* GNUNET_SYSERR to close it (signal serious error)
*/
int
-GMC_handle_broken (void *cls, const struct GNUNET_PeerIdentity *peer,
- const struct GNUNET_MessageHeader *message);
+GMC_handle_broken (void* cls,
+ const struct GNUNET_PeerIdentity* id,
+ const struct GNUNET_MessageHeader* message);
/**
* Core handler for tunnel destruction
const struct GNUNET_MessageHeader *message);
/**
- * Core handler for mesh network traffic going orig->dest.
+ * Core handler for encrypted mesh network traffic (channel mgmt, data).
*
* @param cls Closure (unused).
* @param message Message received.
* GNUNET_SYSERR to close it (signal serious error)
*/
int
-GMC_handle_fwd (void *cls, const struct GNUNET_PeerIdentity *peer,
- const struct GNUNET_MessageHeader *message);
-
-
-/**
- * Core handler for mesh network traffic going dest->orig.
- *
- * @param cls Closure (unused).
- * @param message Message received.
- * @param peer Peer who sent the message.
- *
- * @return GNUNET_OK to keep the connection open,
- * GNUNET_SYSERR to close it (signal serious error)
- */
-int
-GMC_handle_bck (void *cls, const struct GNUNET_PeerIdentity *peer,
- const struct GNUNET_MessageHeader *message);
+GMC_handle_encrypted (void *cls, const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_MessageHeader *message);
/**
* Core handler for mesh network traffic point-to-point acks.
GMC_handle_keepalive (void *cls, const struct GNUNET_PeerIdentity *peer,
const struct GNUNET_MessageHeader *message);
+/**
+ * Send an ACK on the appropriate connection/channel, depending on
+ * the direction and the position of the peer.
+ *
+ * @param c Which connection to send the hop-by-hop ACK.
+ * @param ch Channel, if any.
+ * @param fwd Is this a fwd ACK? (will go dest->root)
+ */
+void
+GMC_send_ack (struct MeshConnection *c, struct MeshChannel *ch, int fwd);
+
/**
* Initialize the connections subsystem
*
*/
struct MeshConnection *
GMC_new (const struct GNUNET_HashCode *cid,
- struct MeshTunnel2 *t,
+ struct MeshTunnel3 *t,
struct MeshPeerPath *p,
unsigned int own_pos);
GMC_get_id (const struct MeshConnection *c);
/**
- * Count connections in a DLL.
+ * Get the connection path.
+ *
+ * @param c Connection to get the path from.
+ *
+ * @return path used by the connection.
*/
-unsigned int
-GMC_count (const struct MeshConnection *head);
+const struct MeshPeerPath *
+GMC_get_path (const struct MeshConnection *c);
/**
- * Send FWD keepalive packets for a connection.
+ * Get the connection state.
*
- * @param cls Closure (connection for which to send the keepalive).
- * @param tc Notification context.
+ * @param c Connection to get the state from.
+ *
+ * @return state of the connection.
*/
-void
-GMC_fwd_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+enum MeshConnectionState
+GMC_get_state (const struct MeshConnection *c);
/**
- * Send BCK keepalive packets for a connection.
+ * Get the connection tunnel.
*
- * @param cls Closure (connection for which to send the keepalive).
- * @param tc Notification context.
+ * @param c Connection to get the tunnel from.
+ *
+ * @return tunnel of the connection.
*/
-void
-GMC_bck_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+struct MeshTunnel3 *
+GMC_get_tunnel (const struct MeshConnection *c);
+/**
+ * Get free buffer space in a connection.
+ *
+ * @param c Connection.
+ * @param fwd Is query about FWD traffic?
+ *
+ * @return Free buffer space [0 - max_msgs_queue/max_connections]
+ */
+unsigned int
+GMC_get_buffer (struct MeshConnection *c, int fwd);
/**
- * Change the tunnel state.
+ * Get how many messages have we allowed to send to us from a direction..
*
- * @param c Connection whose state to change.
- * @param state New state.
+ * @param c Connection.
+ * @param fwd Are we asking about traffic from FWD (BCK messages)?
+ *
+ * @return last_ack_sent - last_pid_recv
*/
-void
-GMC_change_state (struct MeshConnection* c, enum MeshConnectionState state);
+unsigned int
+GMC_get_allowed (struct MeshConnection *c, int fwd);
/**
- * Notify other peers on a connection of a broken link. Mark connections
- * to destroy after all traffic has been sent.
+ * Get messages queued in a connection.
*
- * @param c Connection on which there has been a disconnection.
- * @param peer Peer that disconnected.
- * @param my_full_id My ID (to send to other peers).
+ * @param c Connection.
+ * @param fwd Is query about FWD traffic?
+ *
+ * @return Number of messages queued.
*/
-void
-GMC_notify_broken (struct MeshConnection *c,
- struct MeshPeer *peer,
- struct GNUNET_PeerIdentity *my_full_id);
+unsigned int
+GMC_get_qn (struct MeshConnection *c, int fwd);
/**
- * @brief Queue and pass message to core when possible.
+ * Allow the connection to advertise a buffer of the given size.
+ *
+ * The connection will send an @c fwd ACK message (so: in direction !fwd)
+ * allowing up to last_pid_recv + buffer.
*
- * @param cls Closure (@c type dependant). It will be used by queue_send to
- * build the message to be sent if not already prebuilt.
- * @param type Type of the message, 0 for a raw message.
- * @param size Size of the message.
- * @param c Connection this message belongs to (cannot be NULL).
- * @param ch Channel this message belongs to, if applicable (otherwise NULL).
- * @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
+ * @param c Connection.
+ * @param buffer How many more messages the connection can accept.
+ * @param fwd Is this about FWD traffic? (The ack will go dest->root).
*/
void
-GMC_queue_add (void* cls,
- uint16_t type,
- size_t size,
- struct MeshConnection* c,
- struct MeshChannel* ch,
- int fwd);
-
+GMC_allow (struct MeshConnection *c, unsigned int buffer, int fwd);
/**
- * Free a transmission that was already queued with all resources
- * associated to the request.
+ * Send FWD keepalive packets for a connection.
*
- * @param queue Queue handler to cancel.
- * @param clear_cls Is it necessary to free associated cls?
+ * @param cls Closure (connection for which to send the keepalive).
+ * @param tc Notification context.
*/
void
-GMC_queue_destroy (struct MeshPeerQueue *queue, int clear_cls);
-
+GMC_fwd_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
/**
- * Core callback to write a queued packet to core buffer
- *
- * @param cls Closure (peer info).
- * @param size Number of bytes available in buf.
- * @param buf Where the to write the message.
+ * Send BCK keepalive packets for a connection.
*
- * @return number of bytes written to buf
+ * @param cls Closure (connection for which to send the keepalive).
+ * @param tc Notification context.
*/
-size_t
-GMC_queue_send (void *cls, size_t size, void *buf);
+void
+GMC_bck_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
+/**
+ * Notify other peers on a connection of a broken link. Mark connections
+ * to destroy after all traffic has been sent.
+ *
+ * @param c Connection on which there has been a disconnection.
+ * @param peer Peer that disconnected.
+ */
+void
+GMC_notify_broken (struct MeshConnection *c,
+ struct MeshPeer *peer);
/**
* Is this peer the first one on the connection?
int
GMC_is_terminal (struct MeshConnection *c, int fwd);
+/**
+ * See if we are allowed to send by the next hop in the given direction.
+ *
+ * @param c Connection.
+ * @param fwd Is this about fwd traffic?
+ *
+ * @return GNUNET_YES in case it's OK.
+ */
+int
+GMC_is_sendable (struct MeshConnection *c, int fwd);
+
/**
* Sends an already built message on a connection, properly registering
* all used resources.
struct MeshChannel *ch,
int fwd);
+/**
+ * Sends a CREATE CONNECTION message for a path to a peer.
+ * Changes the connection and tunnel states if necessary.
+ *
+ * @param connection Connection to create.
+ */
+void
+GMC_send_create (struct MeshConnection *connection);
+
+/**
+ * Send a message to all peers in this connection that the connection
+ * is no longer valid.
+ *
+ * If some peer should not receive the message, it should be zero'ed out
+ * before calling this function.
+ *
+ * @param c The connection whose peers to notify.
+ */
+void
+GMC_send_destroy (struct MeshConnection *c);
+
+/**
+ * @brief Start a polling timer for the connection.
+ *
+ * When a neighbor does not accept more traffic on the connection it could be
+ * caused by a simple congestion or by a lost ACK. Polling enables to check
+ * for the lastest ACK status for a connection.
+ *
+ * @param c Connection.
+ * @param fwd Should we poll in the FWD direction?
+ */
+void
+GMC_start_poll (struct MeshConnection *c, int fwd);
+
+
+/**
+ * @brief Stop polling a connection for ACKs.
+ *
+ * Once we have enough ACKs for future traffic, polls are no longer necessary.
+ *
+ * @param c Connection.
+ * @param fwd Should we stop the poll in the FWD direction?
+ */
+void
+GMC_stop_poll (struct MeshConnection *c, int fwd);
#if 0 /* keep Emacsens' auto-indent happy */
{
/* ifndef GNUNET_SERVICE_MESH_CONNECTION_H */
#endif
-/* end of gnunet-service-mesh_connection.h */
\ No newline at end of file
+/* end of gnunet-service-mesh_connection.h */
projects / oweals / gnunet.git / blobdiff