run indent twice, it alternates between two 'canonical' forms, also run whitespace...
[oweals/gnunet.git] / src / transport / gnunet-service-transport_neighbours.h
index 914134ac51eb861252f4ab42e15816500a455530..d7b234889da0bec90c29d7d95c8bfebfd4c33636 100644 (file)
 
 #include "gnunet_statistics_service.h"
 #include "gnunet_transport_service.h"
+#include "gnunet_transport_plugin.h"
 #include "gnunet_util_lib.h"
 
 // TODO:
-// - have a way to access the currently 'connected' session
-//   (for sending and to notice disconnect of it!)
-// - have a way to access/update bandwidth/quota information per peer
-//   (for CostReport/TrafficReport callbacks)
+// - ATS and similar info is a bit lacking in the API right now...
 
 
 
  * @param connect_cb function to call if we connect to a peer
  * @param disconnect_cb function to call if we disconnect from a peer
  */
-void 
-GST_neighbours_start (void *cls,
-                     GNUNET_TRANSPORT_NotifyConnect connect_cb,
-                     GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb);
+void
+GST_neighbours_start (void *cls, GNUNET_TRANSPORT_NotifyConnect connect_cb,
+                      GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb);
 
 
 /**
@@ -69,7 +66,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
  */
@@ -77,6 +74,68 @@ int
 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
+ */
+typedef void (*GST_NeighbourSendContinuation) (void *cls, int success);
+
+
+/**
+ * Transmit a message to the given target using the active connection.
+ *
+ * @param target destination
+ * @param msg message to send
+ * @param msg_size number of bytes in msg
+ * @param timeout when to fail with timeout
+ * @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);
+
+
+/**
+ * We have received a message from the given sender.
+ * How long should we delay before receiving more?
+ * (Also used to keep the peer marked as live).
+ *
+ * @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
+ * @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);
+
+
+/**
+ * Keep the connection to the given neighbour alive longer,
+ * we received a KEEPALIVE (or equivalent).
+ *
+ * @param neighbour neighbour to keep alive
+ */
+void
+GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour);
+
+
+/**
+ * Change the incoming quota for the given peer.
+ *
+ * @param neighbour identity of peer to change qutoa for
+ * @param quota new quota
+ */
+void
+GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
+                                   struct GNUNET_BANDWIDTH_Value32NBO quota);
+
+
 /**
  * If we have an active connection to the given target, it must be shutdown.
  *
@@ -91,77 +150,57 @@ 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)
  */
-typedef void (*GST_NeighbourIterator)(void *cls,
-                                     const struct GNUNET_PeerIdentity *neighbour);
+typedef void (*GST_NeighbourIterator) (void *cls,
+                                       const struct GNUNET_PeerIdentity *
+                                       neighbour,
+                                       const struct
+                                       GNUNET_TRANSPORT_ATS_Information * ats,
+                                       uint32_t ats_count);
 
 
 /**
  * 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);
-
-
-/**
- * We have received a PONG.  Update lifeness of the neighbour.
- *
- * @param sender peer sending the PONG
- * @param hdr the PONG message (presumably)
- * @param plugin_name name of transport that delivered the PONG
- * @param sender_address address of the other peer, NULL if other peer
- *                       connected to us
- * @param sender_address_len number of bytes in sender_address
- * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
- */
-int
-GST_neighbours_handle_pong (const struct GNUNET_PeerIdentity *sender,
-                           const struct GNUNET_MessageHeader *hdr,
-                           const char *plugin_name,
-                           const void *sender_address,
-                           size_t sender_address_len);
+GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
 
 
 /**
- * We have received a CONNECT.  Set the peer to connected.
+ * A session was terminated. Take note.
  *
- * @param sender peer sending the PONG
- * @param hdr the PONG message (presumably)
- * @param plugin_name name of transport that delivered the PONG
- * @param sender_address address of the other peer, NULL if other peer
- *                       connected to us
- * @param sender_address_len number of bytes in sender_address
- * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
+ * @param peer identity of the peer where the session died
+ * @param session session that is gone
  */
-int
-GST_neighbours_handle_connect (const struct GNUNET_PeerIdentity *sender,
-                              const struct GNUNET_MessageHeader *hdr,
-                              const char *plugin_name,
-                              const void *sender_address,
-                              size_t sender_address_len);
+void
+GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
+                                   struct Session *session);
 
 
 /**
- * We have received a DISCONNECT.  Set the peer to disconnected.
+ * For an existing neighbour record, set the active connection to
+ * use the given address.
  *
- * @param sender peer sending the PONG
- * @param hdr the PONG message (presumably)
+ * @param peer identity of the peer to switch the address for
  * @param plugin_name name of transport that delivered the PONG
- * @param sender_address address of the other peer, NULL if other peer
+ * @param address address of the other peer, NULL if other peer
  *                       connected to us
- * @param sender_address_len number of bytes in sender_address
- * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
+ * @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)
  */
-int
-GST_neighbours_handle_disconnect (const struct GNUNET_PeerIdentity *sender,
-                                 const struct GNUNET_MessageHeader *hdr,
-                                 const char *plugin_name,
-                                 const void *sender_address,
-                                 size_t sender_address_len);
+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);
 
 
 #endif