REST/NAMESTORE: rework API
[oweals/gnunet.git] / src / transport / gnunet-service-transport_neighbours.h
index 637e7609b9a1b8f475f2adbf81a04176dc721b0c..92ad62be959e0a6eb012a5446416c9cf7a09e42a 100644 (file)
@@ -1,21 +1,21 @@
 /*
      This file is part of GNUnet.
-     Copyright (C) 2010-2015 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2010-2015 GNUnet e.V.
 
-     GNUnet is free software; you can redistribute it and/or modify
-     it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 3, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
+     Affero General Public License for more details.
+    
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-     You should have received a copy of the GNU General Public License
-     along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
 /**
@@ -50,15 +50,6 @@ void
 GST_neighbours_stop (void);
 
 
-/**
- * Try to create a connection to the given target (eventually).
- *
- * @param target peer to try to connect to
- */
-void
-GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target);
-
-
 /**
  * Test if we're connected to the given peer.
  *
@@ -144,17 +135,6 @@ GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour,
                                    const struct GNUNET_MessageHeader *m);
 
 
-/**
- * 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.
  *
@@ -205,7 +185,7 @@ GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls);
  */
 int
 GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
-                                   struct Session *session);
+                                   struct GNUNET_ATS_Session *session);
 
 
 /**
@@ -221,19 +201,6 @@ GST_neighbours_notify_data_recv (const struct GNUNET_HELLO_Address *address,
                                  const struct GNUNET_MessageHeader *message);
 
 
-/**
- * Track information about payload (useful data) we received from the
- * given address (used to notify ATS about our utilization of
- * allocated resources).
- *
- * @param address the address we got data from
- * @param message the message we received (really only the size is used)
- */
-void
-GST_neighbours_notify_payload_recv (const struct GNUNET_HELLO_Address *address,
-                                    const struct GNUNET_MessageHeader *message);
-
-
 /**
  * Track information about data we transmitted using the given @a
  * address and @a session (used to notify ATS about our utilization of
@@ -245,24 +212,10 @@ GST_neighbours_notify_payload_recv (const struct GNUNET_HELLO_Address *address,
  */
 void
 GST_neighbours_notify_data_sent (const struct GNUNET_HELLO_Address *address,
-                                 struct Session *session,
+                                 struct GNUNET_ATS_Session *session,
                                  size_t size);
 
 
-/**
- * Track information about payload (useful data) we transmitted using the
- * given address (used to notify ATS about our utilization of
- * allocated resources).
- *
- * @param address the address we transmitted data to
- * @param message the message we sent (really only the size is used)
- */
-void
-GST_neighbours_notify_payload_sent (const struct GNUNET_PeerIdentity *peer,
-                                    size_t size);
-
-
-
 /**
  * For an existing neighbour record, set the active connection to
  * use the given address.
@@ -274,7 +227,7 @@ GST_neighbours_notify_payload_sent (const struct GNUNET_PeerIdentity *peer,
  */
 void
 GST_neighbours_switch_to_address (const struct GNUNET_HELLO_Address *address,
-                                  struct Session *session,
+                                  struct GNUNET_ATS_Session *session,
                                   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
                                   struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
 
@@ -283,7 +236,7 @@ GST_neighbours_switch_to_address (const struct GNUNET_HELLO_Address *address,
  * We received a 'SESSION_CONNECT' message from the other peer.
  * Consider switching to it.
  *
- * @param message possibly a 'struct SessionConnectMessage' (check format)
+ * @param message possibly a 'struct GNUNET_ATS_SessionConnectMessage' (check format)
  * @param peer identity of the peer to switch the address for
  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
  */
@@ -296,7 +249,7 @@ GST_neighbours_handle_session_syn (const struct GNUNET_MessageHeader *message,
  * We received a 'SESSION_CONNECT_ACK' message from the other peer.
  * Consider switching to it.
  *
- * @param message possibly a `struct SessionConnectMessage` (check format)
+ * @param message possibly a `struct GNUNET_ATS_SessionConnectMessage` (check format)
  * @param address address of the other peer
  * @param session session to use (or NULL)
  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
@@ -304,7 +257,7 @@ GST_neighbours_handle_session_syn (const struct GNUNET_MessageHeader *message,
 int
 GST_neighbours_handle_session_syn_ack (const struct GNUNET_MessageHeader *message,
                                        const struct GNUNET_HELLO_Address *address,
-                                       struct Session *session);
+                                       struct GNUNET_ATS_Session *session);
 
 
 /**
@@ -312,7 +265,7 @@ GST_neighbours_handle_session_syn_ack (const struct GNUNET_MessageHeader *messag
  * 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 message possibly a 'struct GNUNET_ATS_SessionConnectMessage' (check format)
  * @param address address of the other peer
  * @param session session to use (or NULL)
  * @return #GNUNET_OK if the message was fine, #GNUNET_SYSERR on serious error
@@ -320,7 +273,7 @@ GST_neighbours_handle_session_syn_ack (const struct GNUNET_MessageHeader *messag
 int
 GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
                                   const struct GNUNET_HELLO_Address *address,
-                                  struct Session *session);
+                                  struct GNUNET_ATS_Session *session);
 
 
 /**
@@ -329,10 +282,22 @@ GST_neighbours_handle_session_ack (const struct GNUNET_MessageHeader *message,
  * @param peer
  * @return address currently used
  */
-struct GNUNET_HELLO_Address *
+const struct GNUNET_HELLO_Address *
 GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer);
 
 
+/**
+ * We received a quoat message from the given peer,
+ * validate and process.
+ *
+ * @param peer sender of the message
+ * @param msg the quota message
+ */
+void
+GST_neighbours_handle_quota_message (const struct GNUNET_PeerIdentity *peer,
+                                     const struct GNUNET_MessageHeader *msg);
+
+
 /**
  * We received a disconnect message from the given peer,
  * validate and process.