multicast, psyc, psycstore, client_manager fixes
[oweals/gnunet.git] / src / include / gnunet_transport_service.h
index cfa5fdbe03d204a342df1675d2b19dc656a95d75..7f178e4c49328c9b8528a89461bbce5618e61d01 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     (C) 2009-2014 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009-2014 Christian Grothoff (and other contributing authors)
 
      GNUnet is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published
@@ -14,8 +14,8 @@
 
      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.
+     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+     Boston, MA 02110-1301, USA.
 */
 
 /**
@@ -41,7 +41,7 @@ extern "C"
 /**
  * Version number of the transport API.
  */
-#define GNUNET_TRANSPORT_VERSION 0x00000001
+#define GNUNET_TRANSPORT_VERSION 0x00000002
 
 
 /**
@@ -208,6 +208,23 @@ void
 GNUNET_TRANSPORT_try_connect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch);
 
 
+/**
+ * Opaque handle for a transmission-ready request.
+ */
+struct GNUNET_TRANSPORT_TryDisconnectHandle;
+
+/**
+ * Function to call with result of the try connect request.
+ *
+ * @param cls closure
+ * @param result #GNUNET_OK if message was transmitted to transport service
+ *               #GNUNET_SYSERR if message was not transmitted to transport service
+ */
+typedef void
+(*GNUNET_TRANSPORT_TryDisconnectCallback) (void *cls,
+                                           int result);
+
+
 /**
  * Ask the transport service to disconnect from the given peer.
  *
@@ -219,10 +236,10 @@ GNUNET_TRANSPORT_try_connect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *t
  * @return a `struct GNUNET_TRANSPORT_TryConnectHandle` handle or
  *         NULL on failure (@a cb will not be called)
  */
-struct GNUNET_TRANSPORT_TryConnectHandle *
+struct GNUNET_TRANSPORT_TryDisconnectHandle *
 GNUNET_TRANSPORT_try_disconnect (struct GNUNET_TRANSPORT_Handle *handle,
                                  const struct GNUNET_PeerIdentity *target,
-                                 GNUNET_TRANSPORT_TryConnectCallback cb,
+                                 GNUNET_TRANSPORT_TryDisconnectCallback cb,
                                  void *cb_cls);
 
 
@@ -230,10 +247,10 @@ GNUNET_TRANSPORT_try_disconnect (struct GNUNET_TRANSPORT_Handle *handle,
  * Cancel the request to transport to disconnect.
  * Callback will not be called anymore.
  *
- * @param tch handle for operation to cancel
+ * @param tdh handle for operation to cancel
  */
 void
-GNUNET_TRANSPORT_try_disconnect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch);
+GNUNET_TRANSPORT_try_disconnect_cancel (struct GNUNET_TRANSPORT_TryDisconnectHandle *tdh);
 
 
 /* ************************* Sending *************************** */
@@ -316,34 +333,19 @@ GNUNET_TRANSPORT_check_peer_connected (struct GNUNET_TRANSPORT_Handle *handle,
  *
  * @param handle transport handle
  * @param peer the peer to set the metric for
- * @param inbound set inbound direction (#GNUNET_YES or #GNUNET_NO)
- * @param outbound set outbound direction (#GNUNET_YES or #GNUNET_NO)
- * @param ats the metric as ATS information
- * @param ats_count the number of metrics
- *
- * Supported ATS values:
- * #GNUNET_ATS_QUALITY_NET_DELAY  (value in ms)
- * #GNUNET_ATS_QUALITY_NET_DISTANCE (value in count(hops))
+ * @param prop the performance metrics to set
+ * @param delay_in inbound delay to introduce
+ * @param delay_out outbound delay to introduce
  *
- * Example
- * To enforce a delay of 10 ms for peer p1 in sending direction use:
- *
- * struct GNUNET_ATS_Information ats;
- * ats.type = ntohl (GNUNET_ATS_QUALITY_NET_DELAY);
- * ats.value = ntohl (10);
- * GNUNET_TRANSPORT_set_traffic_metric (th, p1, TM_SEND, &ats, 1);
- *
- * Note:
- * Delay restrictions in receiving direction will be enforced with
- * 1 message delay.
+ * Note: Delay restrictions in receiving direction will be enforced
+ * with one message delay.
  */
 void
 GNUNET_TRANSPORT_set_traffic_metric (struct GNUNET_TRANSPORT_Handle *handle,
                                     const struct GNUNET_PeerIdentity *peer,
-                                    int inbound,
-                                    int outbound,
-                                    const struct GNUNET_ATS_Information *ats,
-                                    size_t ats_count);
+                                    const struct GNUNET_ATS_Properties *prop,
+                                     struct GNUNET_TIME_Relative delay_in,
+                                     struct GNUNET_TIME_Relative delay_out);
 
 
 /* *************************** HELLO *************************** */
@@ -415,7 +417,7 @@ struct GNUNET_TRANSPORT_OfferHelloHandle;
 struct GNUNET_TRANSPORT_OfferHelloHandle *
 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
                               const struct GNUNET_MessageHeader *hello,
-                              GNUNET_SCHEDULER_Task cont, void *cls);
+                              GNUNET_SCHEDULER_TaskCallback cont, void *cls);
 
 
 /**
@@ -655,7 +657,7 @@ struct GNUNET_TRANSPORT_PeerMonitoringContext;
  * @param cls closure
  * @param peer peer this update is about,
  *      NULL if this is the final last callback for a iteration operation
- * @param address address, NULL for disconnect notification in monitor mode
+ * @param address address, NULL if this is the final callback for iteration op
  * @param state current state this peer is in
  * @param state_timeout timeout for the current state of the peer
  */
@@ -772,13 +774,11 @@ enum GNUNET_TRANSPORT_ValidationState
  * the current state of the validation entry,
  *
  * If the monitoring was called with `one_shot==GNUNET_YES`, a final callback
- * with `peer==NULL` and `address==NULL` is executed.
+ * with `address==NULL` is executed.
  *
  * @param cls closure
- * @param peer peer this update is about,
+ * @param address address this update is about,
  *      NULL if this is the final last callback for a iteration operation
- * @param address address,
- *      NULL for disconnect notification in monitor mode
  * @param last_validation when was this address last validated
  * @param valid_until when does this address expire
  * @param next_validation time of the next validation operation
@@ -786,7 +786,6 @@ enum GNUNET_TRANSPORT_ValidationState
  */
 typedef void
 (*GNUNET_TRANSPORT_ValidationIterateCallback) (void *cls,
-                                               const struct GNUNET_PeerIdentity *peer,
                                                const struct GNUNET_HELLO_Address *address,
                                                struct GNUNET_TIME_Absolute last_validation,
                                                struct GNUNET_TIME_Absolute valid_until,
@@ -1044,5 +1043,3 @@ GNUNET_TRANSPORT_monitor_plugins_cancel (struct GNUNET_TRANSPORT_PluginMonitor *
 /* ifndef GNUNET_TRANSPORT_SERVICE_H */
 #endif
 /* end of gnunet_transport_service.h */
-
-