-changing exit helper code to automatically do the network configuration for an exit...
[oweals/gnunet.git] / src / transport / gnunet-service-transport_neighbours.h
index 272f059dd8f1a483cdf109724f2a4d262a3cbe91..5b37ccb6aacbfa3a6f484c7e1964f45dda9cbed1 100644 (file)
@@ -124,6 +124,19 @@ 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
+ *
+ * @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.
@@ -152,19 +165,15 @@ GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
  * @param neighbour identity of the neighbour
  * @param ats performance data
  * @param ats_count number of entries in ats (including 0-termination)
- * @param transport plugin
- * @param addr address
- * @param addrlen address length
+ * @param address the address (or NULL)
  */
 typedef void (*GST_NeighbourIterator) (void *cls,
                                        const struct GNUNET_PeerIdentity *
                                        neighbour,
-                                       const struct
-                                       GNUNET_ATS_Information * ats,
-                                       uint32_t ats_count,
-                                       const char * transport,
-                                       const void * addr,
-                                       size_t addrlen);
+                                       const struct GNUNET_ATS_Information *
+                                       ats, uint32_t ats_count,
+                                       const struct GNUNET_HELLO_Address *
+                                       address);
 
 
 /**
@@ -193,31 +202,27 @@ 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 (excluding 0-termination)
+ * @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 (const struct GNUNET_PeerIdentity *peer,
-                                  const char *plugin_name, const void *address,
-                                  size_t address_len, struct Session *session,
-                                  const struct GNUNET_ATS_Information
-                                  *ats, uint32_t ats_count);
-
-int
 GST_neighbours_switch_to_address_3way (const struct GNUNET_PeerIdentity *peer,
-                                  const char *plugin_name, const void *address,
-                                  size_t address_len, 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);
+                                       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.
@@ -225,77 +230,83 @@ GST_neighbours_switch_to_address_3way (const struct GNUNET_PeerIdentity *peer,
  *
  * @param message possibly a 'struct SessionConnectMessage' (check format)
  * @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 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 char *plugin_name,
-                              const char *sender_address, uint16_t sender_address_len,
-                              struct Session *session,
-                              const struct GNUNET_ATS_Information *ats,
-                              uint32_t ats_count);
-
-/**
- * We received a 'SESSION_CONNECT_ACK' message from the other peer.
- *
- * @param message possibly a 'struct SessionConnectMessage' (check format)
- * @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
-  */
-void
-GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message,
                                const struct GNUNET_PeerIdentity *peer,
-                               const char *plugin_name,
-                               const char *sender_address, uint16_t sender_address_len,
+                               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.
+ * 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 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
-  */
+ */
+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);
+
 void
 GST_neighbours_handle_ack (const struct GNUNET_MessageHeader *message,
-    const struct GNUNET_PeerIdentity *peer,
-    const char *plugin_name,
-    const char *sender_address, uint16_t sender_address_len,
-    struct Session *session,
-    const struct GNUNET_ATS_Information *ats,
-    uint32_t ats_count);
+                           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_handle_disconnect_message (const struct GNUNET_PeerIdentity *peer,
-                                         const struct GNUNET_MessageHeader *msg);
+GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity
+                                          *peer,
+                                          const struct GNUNET_MessageHeader
+                                          *msg);
 
 
 #endif