determine network scope for ATS even if we do not yet have a session and only have...
[oweals/gnunet.git] / src / transport / plugin_transport_udp.h
index 3770b3b70584392b361e85b3429130f9bdbb52ad..5f8366636b81d38c50280c4da36896556b67caec 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet
-     (C) 2010-2014 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2010-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.
 */
 
 /**
@@ -102,31 +102,33 @@ struct IPv6UdpAddress
 };
 GNUNET_NETWORK_STRUCT_END
 
-
 /**
- * UDP Message-Packet header (after defragmentation).
+ * Either an IPv4 or IPv6 UDP address.  Note that without a "length",
+ * one cannot tell which one of the two types this address represents.
  */
-struct UDPMessage
+union UdpAddress
 {
   /**
-   * Message header.
+   * IPv4 case.
    */
-  struct GNUNET_MessageHeader header;
+  struct IPv4UdpAddress v4;
 
   /**
-   * Always zero for now.
+   * IPv6 case.
    */
-  uint32_t reserved;
-
-  /**
-   * What is the identity of the sender
-   */
-  struct GNUNET_PeerIdentity sender;
-
+  struct IPv6UdpAddress v6;
 };
 
+
+/**
+ * Information we track for each message in the queue.
+ */
 struct UDP_MessageWrapper;
 
+
+/**
+ * Closure for #append_port().
+ */
 struct PrettyPrinterContext;
 
 
@@ -155,12 +157,12 @@ struct Plugin
   /**
    * ID of select task for IPv4
    */
-  GNUNET_SCHEDULER_TaskIdentifier select_task;
+  struct GNUNET_SCHEDULER_Task *select_task_v4;
 
   /**
    * ID of select task for IPv6
    */
-  GNUNET_SCHEDULER_TaskIdentifier select_task_v6;
+  struct GNUNET_SCHEDULER_Task *select_task_v6;
 
   /**
    * Tokenizer for inbound messages.
@@ -188,44 +190,24 @@ struct Plugin
   struct GNUNET_NAT_Handle *nat;
 
   /**
-   * FD Read set
-   */
-  struct GNUNET_NETWORK_FDSet *rs_v4;
-
-  /**
-   * FD Write set
+   * Handle to NAT traversal support.
    */
-  struct GNUNET_NETWORK_FDSet *ws_v4;
-
+  struct GNUNET_NAT_STUN_Handle *stun;
+  
   /**
    * The read socket for IPv4
    */
   struct GNUNET_NETWORK_Handle *sockv4;
 
-  /**
-   * FD Read set
-   */
-  struct GNUNET_NETWORK_FDSet *rs_v6;
-
-  /**
-   * FD Write set
-   */
-  struct GNUNET_NETWORK_FDSet *ws_v6;
-
   /**
    * The read socket for IPv6
    */
   struct GNUNET_NETWORK_Handle *sockv6;
 
   /**
-   * Tokenizer for inbound IPv6 messages.
-   */
-  struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_ipv6_mst;
-
-  /**
-   * Tokenizer for inbound IPv4 messages.
+   * Tokenizer for inbound messages.
    */
-  struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_ipv4_mst;
+  struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_mst;
 
   /**
    * Head of DLL of broadcast addresses
@@ -335,21 +317,49 @@ struct Plugin
 };
 
 
+/**
+ * Function called for a quick conversion of the binary address to
+ * a numeric address.  Note that the caller must not free the
+ * address and that the next call to this function is allowed
+ * to override the address again.
+ *
+ * @param cls closure
+ * @param addr binary address (a `union UdpAddress`)
+ * @param addrlen length of the @a addr
+ * @return string representing the same address
+ */
 const char *
-udp_address_to_string (void *cls, const void *addr, size_t addrlen);
+udp_address_to_string (void *cls,
+                       const void *addr,
+                       size_t addrlen);
 
+
+/**
+ * We received a broadcast message.  Process it and all subsequent
+ * messages in the same packet.
+ *
+ * @param plugin the UDP plugin
+ * @param buf the buffer with the message(s)
+ * @param size number of bytes in @a buf
+ * @param udp_addr address of the sender
+ * @param udp_addr_len number of bytes in @a udp_addr
+ * @param network_type network type of the sender's address
+ */
 void
 udp_broadcast_receive (struct Plugin *plugin,
-                       const char * buf,
+                       const char *buf,
                        ssize_t size,
-                       const struct sockaddr *addr,
-                       size_t addrlen);
+                       const union UdpAddress *udp_addr,
+                       size_t udp_addr_len,
+                       enum GNUNET_ATS_Network_Type network_type);
+
 
 void
 setup_broadcast (struct Plugin *plugin,
                  struct sockaddr_in6 *server_addrv6,
                  struct sockaddr_in *server_addrv4);
 
+
 void
 stop_broadcast (struct Plugin *plugin);