error msg
[oweals/gnunet.git] / src / transport / gnunet-service-transport_neighbours.h
index e85f1a4d06b2e404c1c859ca36f8b8d9dd4607d7..f6e3387bf234139a6eb6549c7fcad42d8d54c7fe 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
+ * @param max_fds maximum number of fds to use
  */
 void
-GST_neighbours_start (void *cls, GNUNET_TRANSPORT_NotifyConnect connect_cb,
-                      GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb);
+GST_neighbours_start (void *cls,
+                                                                       NotifyConnect connect_cb,
+                      GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb,
+                      GNUNET_TRANSPORT_PeerIterateCallback peer_address_cb,
+                      unsigned int max_fds);
 
 
 /**
@@ -80,7 +86,9 @@ 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);
 
 
 /**
@@ -124,6 +132,7 @@ GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
 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
@@ -134,7 +143,7 @@ GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour);
  */
 void
 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
-                                   const struct GNUNET_ATS_Information * ats,
+                                   const struct GNUNET_ATS_Information *ats,
                                    uint32_t ats_count);
 
 
@@ -166,13 +175,18 @@ GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
  * @param ats performance data
  * @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_ATS_Information *
                                        ats, uint32_t ats_count,
-                                       const struct GNUNET_HELLO_Address *address);
+                                       const struct GNUNET_HELLO_Address *
+                                       address,
+                                       struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+                                       struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 
 
 /**
@@ -190,8 +204,10 @@ 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
+int
 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
                                    struct Session *session);
 
@@ -208,19 +224,15 @@ GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
  * @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
- * @return GNUNET_YES if we are currently connected, GNUNET_NO if the
- *         connection is not up (yet)
  */
-int
-GST_neighbours_switch_to_address_3way (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);
+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);
 
 
 /**
@@ -259,24 +271,37 @@ GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
 void
 GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
                                    const struct GNUNET_PeerIdentity *peer,
-                                  const struct GNUNET_HELLO_Address *address,
+                                   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_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);
+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 
+ * @param peer
  * @return observed latency of the address, FOREVER if the address was
  *         never successfully validated
  */