indentation
[oweals/gnunet.git] / src / include / gnunet_transport_plugin.h
index 83ecf6fb8bb6f3c1e9f2cc8b1d4b7168aa56d808..b90f3f1cfa6281e87b14faf61cd33d675bc77d73 100644 (file)
@@ -63,7 +63,7 @@ struct SessionHeader
    * Expiration time for signature.  Do not use in the plugin!
    */
   struct GNUNET_TIME_Absolute pong_sig_expires;
-  
+
 };
 
 /**
@@ -71,15 +71,17 @@ struct SessionHeader
  * cleans up a session pointer and hence the service needs to
  * discard all of those sessions as well.  Plugins that do not
  * use sessions can simply omit calling this function and always
- * use NULL wherever a session pointer is needed.
+ * use NULL wherever a session pointer is needed.  This function
+ * should be called BEFORE a potential "TransmitContinuation"
+ * from the "TransmitFunction".
  * 
  * @param cls closure
  * @param peer which peer was the session for 
  * @param session which session is being destoyed
  */
 typedef void (*GNUNET_TRANSPORT_SessionEnd) (void *cls,
-                                            const struct GNUNET_PeerIdentity *peer,
-                                            struct Session *session);
+                                             const struct GNUNET_PeerIdentity *
+                                             peer, struct Session * session);
 
 
 /**
@@ -90,8 +92,7 @@ typedef void (*GNUNET_TRANSPORT_SessionEnd) (void *cls,
  * @param cls closure
  * @param peer (claimed) identity of the other peer
  * @param message the message, NULL if we only care about
- *                learning about the delay until we should receive again -- FIXME!
- * @param distance in overlay hops; use 1 unless DV (or 0 if message == NULL)
+ *                learning about the delay until we should receive again
  * @param session identifier used for this session (NULL for plugins
  *                that do not offer bi-directional communication to the sender
  *                using the same "connection")
@@ -104,18 +105,26 @@ typedef void (*GNUNET_TRANSPORT_SessionEnd) (void *cls,
  * @return how long the plugin should wait until receiving more data
  *         (plugins that do not support this, can ignore the return value)
  */
-typedef struct GNUNET_TIME_Relative (*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
-                                                                              const struct
-                                                                              GNUNET_PeerIdentity *
-                                                                              peer,
-                                                                              const struct
-                                                                              GNUNET_MessageHeader *
-                                                                              message,
-                                                                              const struct GNUNET_TRANSPORT_ATS_Information *ats,
-                                                                  uint32_t ats_count,
-                                                                              struct Session *session,
-                                                                              const char *sender_address,
-                                                                              uint16_t sender_address_len);
+typedef struct
+    GNUNET_TIME_Relative (*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
+                                                                    const struct
+                                                                    GNUNET_PeerIdentity
+                                                                    * peer,
+                                                                    const struct
+                                                                    GNUNET_MessageHeader
+                                                                    * message,
+                                                                    const struct
+                                                                    GNUNET_TRANSPORT_ATS_Information
+                                                                    * ats,
+                                                                    uint32_t
+                                                                    ats_count,
+                                                                    struct
+                                                                    Session *
+                                                                    session,
+                                                                    const char
+                                                                    *sender_address,
+                                                                    uint16_t
+                                                                    sender_address_len);
 
 
 /**
@@ -123,19 +132,17 @@ typedef struct GNUNET_TIME_Relative (*GNUNET_TRANSPORT_PluginReceiveCallback) (v
  * is aware that it might be reachable under.
  *
  * @param cls closure
- * @param name name of the transport that generated the address
- * @param addr one of the addresses of the host, NULL for the last address
+ * @param add_remove should the address added (YES) or removed (NO) from the
+ *                   set of valid addresses?
+ * @param addr one of the addresses of the host
  *        the specific address format depends on the transport
  * @param addrlen length of the address
- * @param expires when should this address automatically expire?
  */
 typedef void (*GNUNET_TRANSPORT_AddressNotification) (void *cls,
-                                                      const char *name,
+                                                      int add_remove,
                                                       const void *addr,
-                                                      uint16_t addrlen,
-                                                      struct
-                                                      GNUNET_TIME_Relative
-                                                      expires);
+                                                      size_t addrlen);
+
 
 /**
  * Function that will be called whenever the plugin receives data over
@@ -152,29 +159,22 @@ typedef void (*GNUNET_TRANSPORT_AddressNotification) (void *cls,
  * @return how long to wait until reading more from this peer
  *         (to enforce inbound quotas)
  */
-typedef struct GNUNET_TIME_Relative (*GNUNET_TRANSPORT_TrafficReport) (void *cls,
-                                                                      const struct
-                                                                      GNUNET_PeerIdentity *peer,
-                                                                      size_t amount_recved);
+typedef struct GNUNET_TIME_Relative (*GNUNET_TRANSPORT_TrafficReport) (void
+                                                                       *cls,
+                                                                       const
+                                                                       struct
+                                                                       GNUNET_PeerIdentity
+                                                                       * peer,
+                                                                       size_t
+                                                                       amount_recved);
+
 
 /**
- * Function called whenever the plugin has to notify ATS about costs for using this transport
- *
- * The cost will be passed as struct GNUNET_TRANSPORT_ATS_Cost_Information[]
- * This array is 0-terminated, so the last element will be a pair:
- * ((cost->cost_type==GNUNET_TRANSPORT_ATS_ARRAY_TERMINATOR) && cost->cost_value==0))
- *
- * @param cls closure
- * @param peer peer
- * @param addr peer address
- * @param addrlen address length
- * @param cost pointer to the first element of struct GNUNET_TRANSPORT_ATS_Cost_Information[]
+ * Function that returns a HELLO message.
  */
-typedef void (*GNUNET_TRANSPORT_CostReport) (void *cls,
-                                                                                        const struct GNUNET_PeerIdentity *peer,
-                                             const void *addr,
-                                             uint16_t addrlen,
-                                                                                        struct GNUNET_TRANSPORT_ATS_Information * cost);
+typedef const struct GNUNET_MessageHeader
+    *(*GNUNET_TRANSPORT_GetHelloCallback) (void);
+
 
 /**
  * The transport service will pass a pointer to a struct
@@ -193,12 +193,6 @@ struct GNUNET_TRANSPORT_PluginEnvironment
    */
   const struct GNUNET_PeerIdentity *my_identity;
 
-  /**
-   * Pointer (!) to our HELLO message.  Note that the address
-   * referred to "*our_hello" might change over time.
-   */
-  struct GNUNET_HELLO_Message *const*our_hello;
-
   /**
    * Closure for the various callbacks.
    */
@@ -215,6 +209,12 @@ struct GNUNET_TRANSPORT_PluginEnvironment
    */
   GNUNET_TRANSPORT_PluginReceiveCallback receive;
 
+
+  /**
+   * Function that returns our HELLO.
+   */
+  GNUNET_TRANSPORT_GetHelloCallback get_our_hello;
+
   /**
    * Function that must be called by each plugin to notify the
    * transport service about the addresses under which the transport
@@ -222,23 +222,12 @@ struct GNUNET_TRANSPORT_PluginEnvironment
    */
   GNUNET_TRANSPORT_AddressNotification notify_address;
 
-  /**
-   * Inform service about traffic received, get information
-   * about when we might be willing to receive more.
-   */
-  GNUNET_TRANSPORT_TrafficReport traffic_report;
-
   /**
    * Function that must be called by the plugin when a non-NULL
    * session handle stops being valid (is destroyed).
    */
   GNUNET_TRANSPORT_SessionEnd session_end;
 
-  /**
-   * Inform service about costs for using this transport plugin
-   */
-  GNUNET_TRANSPORT_CostReport cost_report;
-
   /**
    * What is the maximum number of connections that this transport
    * should allow?  Transports that do not have sessions (such as
@@ -251,7 +240,12 @@ struct GNUNET_TRANSPORT_PluginEnvironment
 
 /**
  * Function called by the GNUNET_TRANSPORT_TransmitFunction
- * upon "completion".
+ * upon "completion".  In the case that a peer disconnects,
+ * this function must be called for each pending request
+ * (with a 'failure' indication) AFTER notifying the service
+ * about the disconnect event (so that the service won't try
+ * to transmit more messages, believing the connection still
+ * exists...).
  *
  * @param cls closure
  * @param target who was the recipient of the message?
@@ -261,9 +255,9 @@ struct GNUNET_TRANSPORT_PluginEnvironment
  *               the ReceiveCallback.
  */
 typedef void
-  (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
-                                            const struct GNUNET_PeerIdentity *
-                                            target, int result);
+    (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
+                                              const struct GNUNET_PeerIdentity *
+                                              target, int result);
 
 
 /**
@@ -303,19 +297,19 @@ typedef void
  *         and does NOT mean that the message was not transmitted (DV)
  */
 typedef ssize_t
-  (*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
-                                        const struct GNUNET_PeerIdentity *
-                                        target,
-                                        const char *msgbuf,
-                                        size_t msgbuf_size,
-                                        uint32_t priority,
-                                        struct GNUNET_TIME_Relative timeout,
-                                       struct Session *session,
-                                        const void *addr,
-                                       size_t addrlen,
-                                       int force_address,
-                                       GNUNET_TRANSPORT_TransmitContinuation
-                                        cont, void *cont_cls);
+    (*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
+                                          const struct GNUNET_PeerIdentity *
+                                          target,
+                                          const char *msgbuf,
+                                          size_t msgbuf_size,
+                                          uint32_t priority,
+                                          struct GNUNET_TIME_Relative timeout,
+                                          struct Session * session,
+                                          const void *addr,
+                                          size_t addrlen,
+                                          int force_address,
+                                          GNUNET_TRANSPORT_TransmitContinuation
+                                          cont, void *cont_cls);
 
 
 /**
@@ -335,9 +329,9 @@ typedef ssize_t
  *        to be cancelled
  */
 typedef void
-  (*GNUNET_TRANSPORT_DisconnectFunction) (void *cls,
-                                          const struct GNUNET_PeerIdentity *
-                                          target);
+    (*GNUNET_TRANSPORT_DisconnectFunction) (void *cls,
+                                            const struct GNUNET_PeerIdentity *
+                                            target);
 
 
 /**
@@ -367,15 +361,15 @@ typedef void (*GNUNET_TRANSPORT_AddressStringCallback) (void *cls,
  * @param asc_cls closure for asc
  */
 typedef void
-  (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
-                                            const char *type,
-                                            const void *addr,
-                                            size_t addrlen,
-                                            int numeric,
-                                            struct GNUNET_TIME_Relative
-                                            timeout,
-                                            GNUNET_TRANSPORT_AddressStringCallback
-                                            asc, void *asc_cls);
+    (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
+                                              const char *type,
+                                              const void *addr,
+                                              size_t addrlen,
+                                              int numeric,
+                                              struct GNUNET_TIME_Relative
+                                              timeout,
+                                              GNUNET_TRANSPORT_AddressStringCallback
+                                              asc, void *asc_cls);
 
 
 /**
@@ -393,8 +387,8 @@ typedef void
  *         and transport, GNUNET_SYSERR if not
  */
 typedef int
-(*GNUNET_TRANSPORT_CheckAddress) (void *cls,
-                                 const void *addr, size_t addrlen);
+    (*GNUNET_TRANSPORT_CheckAddress) (void *cls,
+                                      const void *addr, size_t addrlen);
 
 
 /**
@@ -408,9 +402,9 @@ typedef int
  * @param addr_len length of the address
  * @return string representing the same address 
  */
-typedef const char(*GNUNET_TRANSPORT_AddressToString) (void *cls,
-                                                        const void *addr,
-                                                        size_t addrlen);
+typedef const char *(*GNUNET_TRANSPORT_AddressToString) (void *cls,
+                                                         const void *addr,
+                                                         size_t addrlen);
 
 
 /**
@@ -437,9 +431,7 @@ struct GNUNET_TRANSPORT_PluginFunctions
   /**
    * Function that can be used to force the plugin to disconnect from
    * the given peer and cancel all previous transmissions (and their
-   * continuations).  Note that if the transport does not have
-   * sessions / persistent connections (for example, UDP), this
-   * function may very well do nothing.
+   * continuations).  
    */
   GNUNET_TRANSPORT_DisconnectFunction disconnect;