- fix error messages
[oweals/gnunet.git] / src / transport / gnunet-service-transport_neighbours.h
index 5b37ccb6aacbfa3a6f484c7e1964f45dda9cbed1..01fbe83d7dd8c8d4355f580483deefcd11393e61 100644 (file)
@@ -29,6 +29,8 @@
 #include "gnunet_statistics_service.h"
 #include "gnunet_transport_service.h"
 #include "gnunet_transport_plugin.h"
+#include "gnunet-service-transport.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_NeighbourChangeCallback peer_address_cb,
+                      unsigned int max_fds);
 
 
 /**
@@ -68,7 +75,7 @@ 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
+ * @return #GNUNET_YES if we are connected, #GNUNET_NO if not
  */
 int
 GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
@@ -78,9 +85,11 @@ GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
  * Function called after the transmission is done.
  *
  * @param cls closure
- * @param success GNUNET_OK on success, GNUNET_NO on failure, GNUNET_SYSERR if we're not connected
+ * @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);
 
 
 /**
@@ -88,10 +97,10 @@ typedef void (*GST_NeighbourSendContinuation) (void *cls, int success);
  *
  * @param target destination
  * @param msg message to send
- * @param msg_size number of bytes in msg
+ * @param msg_size number of bytes in @a msg
  * @param timeout when to fail with timeout
  * @param cont function to call when done
- * @param cont_cls closure for 'cont'
+ * @param cont_cls closure for @a cont
  */
 void
 GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
@@ -106,8 +115,8 @@ GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg,
  *
  * @param sender sender of the message
  * @param size size of the message
- * @param do_forward set to GNUNET_YES if the message should be forwarded to clients
- *                   GNUNET_NO if the neighbour is not connected or violates the quota
+ * @param do_forward set to #GNUNET_YES if the message should be forwarded to clients
+ *                   #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
@@ -117,25 +126,27 @@ GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity
 
 /**
  * Keep the connection to the given neighbour alive longer,
- * we received a KEEPALIVE (or equivalent).
+ * we received a KEEPALIVE (or equivalent); send a response.
  *
- * @param neighbour neighbour to keep alive
+ * @param neighbour neighbour to keep alive (by sending keep alive response)
+ * @param m the keep alive message containing the nonce to respond to
  */
 void
-GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour);
+GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour,
+                          const struct GNUNET_MessageHeader *m);
+
 
 /**
- * We received a KEEP_ALIVE_RESPONSE message and use this to calculate latency
- * to this peer
+ * We received a KEEP_ALIVE_RESPONSE message and use this to calculate
+ * latency to this peer.  Pass the updated information (existing ats
+ * plus calculated latency) to ATS.
  *
  * @param neighbour neighbour to keep alive
- * @param ats performance data
- * @param ats_count number of entries in ats
+ * @param m the message containing the keep alive response
  */
 void
 GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
-                                   const struct GNUNET_ATS_Information *ats,
-                                   uint32_t ats_count);
+    const struct GNUNET_MessageHeader *m);
 
 
 /**
@@ -159,28 +170,30 @@ GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
 
 
 /**
- * Function called for each connected neighbour.
+ * Function called for each neighbour.
  *
  * @param cls closure
  * @param neighbour identity of the neighbour
- * @param ats performance data
- * @param ats_count number of entries in ats (including 0-termination)
  * @param address the address (or NULL)
+ * @param state current state the peer is in
+ * @param state_timeout timeout for this state
+ * @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_PeerIdentity *neighbour,
+                                       const struct GNUNET_HELLO_Address *address,
+                                       enum GNUNET_TRANSPORT_PeerState state,
+                                       struct GNUNET_TIME_Absolute state_timeout,
+                                       struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+                                       struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 
 
 /**
  * Iterate over all connected neighbours.
  *
  * @param cb function to call
- * @param cb_cls closure for cb
+ * @param cb_cls closure for @a cb
  */
 void
 GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
@@ -191,12 +204,40 @@ 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);
 
 
+void
+GST_neighbours_notify_data_recv (const struct GNUNET_PeerIdentity *peer,
+                                 const struct GNUNET_HELLO_Address *address,
+                                 struct Session *session,
+                                 const struct GNUNET_MessageHeader *message);
+
+
+void
+GST_neighbours_notify_payload_recv (const struct GNUNET_PeerIdentity *peer,
+                                    const struct GNUNET_HELLO_Address *address,
+                                    struct Session *session,
+                                    const struct GNUNET_MessageHeader *message);
+
+
+void
+GST_neighbours_notify_payload_sent (const struct GNUNET_PeerIdentity *peer,
+                                    size_t size);
+
+
+void
+GST_neighbours_notify_data_sent (const struct GNUNET_PeerIdentity *peer,
+                                 const struct GNUNET_HELLO_Address *address,
+                                 struct Session *session,
+                                 size_t size);
+
+
 /**
  * For an existing neighbour record, set the active connection to
  * use the given address.
@@ -209,19 +250,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);
 
 
 /**
@@ -233,16 +270,13 @@ GST_neighbours_switch_to_address_3way (const struct GNUNET_PeerIdentity *peer,
  * @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
+ * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
+ */
+int
 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);
+                               struct Session *session);
 
 
 /**
@@ -254,24 +288,32 @@ GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message,
  * @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
+ * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
  */
-void
+int
 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);
+                                   struct Session *session);
 
-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);
+
+/**
+ * We received a 'SESSION_ACK' message from the other peer.
+ * If we sent a 'CONNECT_ACK' last, this means we are now
+ * connected.  Otherwise, do nothing.
+ *
+ * @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)
+ * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
+ */
+int
+GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
+                                  const struct GNUNET_PeerIdentity *peer,
+                                  const struct GNUNET_HELLO_Address *address,
+                                  struct Session *session);
 
 
 /**