msg
[oweals/gnunet.git] / src / transport / gnunet-service-transport_neighbours.h
index c0cee01a6cacb99c6739687d1d7cd4e911cdef19..6a743359f16e7bbbc05bb89d681c2d343efafd40 100644 (file)
@@ -29,6 +29,7 @@
 #include "gnunet_statistics_service.h"
 #include "gnunet_transport_service.h"
 #include "gnunet_transport_plugin.h"
+#include "transport.h"
 #include "gnunet_util_lib.h"
 
 // TODO:
  * @param cls closure for callbacks
  * @param connect_cb function to call if we connect to a peer
  * @param disconnect_cb function to call if we disconnect from a peer
+ * @param peer_address_cb function to call if a neighbour's active address changes
  */
-void GST_neighbours_start (void *cls, GNUNET_TRANSPORT_NotifyConnect connect_cb,
-                           GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb);
+void
+GST_neighbours_start (void *cls,
+                      NotifyConnect connect_cb,
+                      GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb,
+                      GNUNET_TRANSPORT_PeerIterateCallback peer_address_cb);
 
 
 /**
  * Cleanup the neighbours subsystem.
  */
-void GST_neighbours_stop (void);
+void
+GST_neighbours_stop (void);
 
 
 /**
@@ -58,16 +64,18 @@ void GST_neighbours_stop (void);
  *
  * @param target peer to try to connect to
  */
-void GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
+void
+GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
 
 
 /**
  * Test if we're connected to the given peer.
- * 
+ *
  * @param target peer to test
  * @return GNUNET_YES if we are connected, GNUNET_NO if not
  */
-int GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
+int
+GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
 
 
 /**
@@ -76,7 +84,9 @@ int GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
  * @param cls closure
  * @param success GNUNET_OK on success, GNUNET_NO on failure, GNUNET_SYSERR if we're not connected
  */
-typedef void (*GST_NeighbourSendContinuation) (void *cls, int success);
+typedef void (*GST_NeighbourSendContinuation) (void *cls, int success,
+                                               size_t bytes_payload,
+                                               size_t bytes_on_wire);
 
 
 /**
@@ -89,10 +99,10 @@ typedef void (*GST_NeighbourSendContinuation) (void *cls, int success);
  * @param cont function to call when done
  * @param cont_cls closure for 'cont'
  */
-void GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
-                          const void *msg, size_t msg_size,
-                          struct GNUNET_TIME_Relative timeout,
-                          GST_NeighbourSendContinuation cont, void *cont_cls);
+void
+GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
+                     size_t msg_size, struct GNUNET_TIME_Relative timeout,
+                     GST_NeighbourSendContinuation cont, void *cont_cls);
 
 
 /**
@@ -106,13 +116,9 @@ void GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
  *                   GNUNET_NO if the neighbour is not connected or violates the quota
  * @return how long to wait before reading more from this sender
  */
-struct GNUNET_TIME_Relative GST_neighbours_calculate_receive_delay (const struct
-                                                                    GNUNET_PeerIdentity
-                                                                    *sender,
-                                                                    ssize_t
-                                                                    size,
-                                                                    int
-                                                                    *do_forward);
+struct GNUNET_TIME_Relative
+GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
+                                        *sender, ssize_t size, int *do_forward);
 
 
 /**
@@ -121,19 +127,33 @@ struct GNUNET_TIME_Relative GST_neighbours_calculate_receive_delay (const struct
  *
  * @param neighbour neighbour to keep alive
  */
-void GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour);
+void
+GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour);
+
+
+/**
+ * We received a KEEP_ALIVE_RESPONSE message and use this to calculate latency
+ * to this peer
+ *
+ * @param neighbour neighbour to keep alive
+ * @param ats performance data
+ * @param ats_count number of entries in ats
+ */
+void
+GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
+                                   const struct GNUNET_ATS_Information *ats,
+                                   uint32_t ats_count);
 
 
 /**
  * Change the incoming quota for the given peer.
  *
  * @param neighbour identity of peer to change qutoa for
- * @param quota new quota 
+ * @param quota new quota
  */
-void GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity
-                                        *neighbour,
-                                        struct GNUNET_BANDWIDTH_Value32NBO
-                                        quota);
+void
+GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
+                                   struct GNUNET_BANDWIDTH_Value32NBO quota);
 
 
 /**
@@ -141,7 +161,8 @@ void GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity
  *
  * @param target peer to disconnect from
  */
-void GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
+void
+GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
 
 
 /**
@@ -150,23 +171,30 @@ void GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
  * @param cls closure
  * @param neighbour identity of the neighbour
  * @param ats performance data
- * @param ats_count number of entries in ats (excluding 0-termination)
+ * @param ats_count number of entries in ats (including 0-termination)
+ * @param address the address (or NULL)
+ * @param bandwidth_in inbound quota in NBO
+ * @param bandwidth_out outbound quota in NBO
  */
 typedef void (*GST_NeighbourIterator) (void *cls,
                                        const struct GNUNET_PeerIdentity *
                                        neighbour,
-                                       const struct
-                                       GNUNET_TRANSPORT_ATS_Information * ats,
-                                       uint32_t ats_count);
+                                       const struct GNUNET_ATS_Information *
+                                       ats, uint32_t ats_count,
+                                       const struct GNUNET_HELLO_Address *
+                                       address,
+                                       struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+                                       struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 
 
 /**
  * Iterate over all connected neighbours.
  *
- * @param cb function to call 
+ * @param cb function to call
  * @param cb_cls closure for cb
  */
-void GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
+void
+GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
 
 
 /**
@@ -174,9 +202,12 @@ void GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
  *
  * @param peer identity of the peer where the session died
  * @param session session that is gone
+ * @return GNUNET_YES if this was a session used, GNUNET_NO if
+ *        this session was not in use
  */
-void GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
-                                        struct Session *session);
+int
+GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
+                                   struct Session *session);
 
 
 /**
@@ -184,21 +215,120 @@ void GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
  * use the given address.
  *
  * @param peer identity of the peer to switch the address for
- * @param plugin_name name of transport that delivered the PONG
  * @param address address of the other peer, NULL if other peer
  *                       connected to us
- * @param address_len number of bytes in address
+ * @param session session to use (or NULL)
+ * @param ats performance data
+ * @param ats_count number of entries in ats
+ * @param bandwidth_in inbound quota to be used when connection is up
+ * @param bandwidth_out outbound quota to be used when connection is up
+ */
+void
+GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
+                                       const struct GNUNET_HELLO_Address
+                                       *address, struct Session *session,
+                                       const struct GNUNET_ATS_Information *ats,
+                                       uint32_t ats_count,
+                                       struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+                                       struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
+
+
+/**
+ * We received a 'SESSION_CONNECT' message from the other peer.
+ * Consider switching to it.
+ *
+ * @param message possibly a 'struct SessionConnectMessage' (check format)
+ * @param peer identity of the peer to switch the address for
+ * @param address address of the other peer, NULL if other peer
+ *                       connected to us
  * @param session session to use (or NULL)
  * @param ats performance data
  * @param ats_count number of entries in ats (excluding 0-termination)
+  */
+void
+GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
+                               const struct GNUNET_PeerIdentity *peer,
+                               const struct GNUNET_HELLO_Address *address,
+                               struct Session *session,
+                               const struct GNUNET_ATS_Information *ats,
+                               uint32_t ats_count);
+
+
+/**
+ * We received a 'SESSION_CONNECT_ACK' message from the other peer.
+ * Consider switching to it.
+ *
+ * @param message possibly a 'struct SessionConnectMessage' (check format)
+ * @param peer identity of the peer to switch the address for
+ * @param address address of the other peer, NULL if other peer
+ *                       connected to us
+ * @param session session to use (or NULL)
+ * @param ats performance data
+ * @param ats_count number of entries in ats
+ */
+void
+GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
+                                   const struct GNUNET_PeerIdentity *peer,
+                                   const struct GNUNET_HELLO_Address *address,
+                                   struct Session *session,
+                                   const struct GNUNET_ATS_Information *ats,
+                                   uint32_t ats_count);
+
+
+/**
+ * We received a 'SESSION_ACK' message from the other peer.
+ * FIXME: describe what this means!
+ *
+ * @param message possibly a 'struct SessionConnectMessage' (check format)
+ * @param peer identity of the peer to switch the address for
+ * @param address address of the other peer, NULL if other peer
+ *                       connected to us
+ * @param session session to use (or NULL)
+ * @param ats performance data
+ * @param ats_count number of entries in ats
+ */
+void
+GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
+                                  const struct GNUNET_PeerIdentity *peer,
+                                  const struct GNUNET_HELLO_Address *address,
+                                  struct Session *session,
+                                  const struct GNUNET_ATS_Information *ats,
+                                  uint32_t ats_count);
+
+
+/**
+ * Obtain current latency information for the given neighbour.
+ *
+ * @param peer
+ * @return observed latency of the address, FOREVER if the address was
+ *         never successfully validated
+ */
+struct GNUNET_TIME_Relative
+GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer);
+
+
+/**
+ * Obtain current address information for the given neighbour.
+ *
+ * @param peer
+ * @return address currently used
+ */
+struct GNUNET_HELLO_Address *
+GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
+
+
+/**
+ * We received a disconnect message from the given peer,
+ * validate and process.
+ *
+ * @param peer sender of the message
+ * @param msg the disconnect message
  */
-void GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer,
-                                       const char *plugin_name,
-                                       const void *address, size_t address_len,
-                                       struct Session *session,
-                                       const struct
-                                       GNUNET_TRANSPORT_ATS_Information *ats,
-                                       uint32_t ats_count);
+void
+GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
+                                          *peer,
+                                          const struct GNUNET_MessageHeader
+                                          *msg);
 
 
 #endif