call GNUNET_SERVER_receive_done() also on internal error paths
[oweals/gnunet.git] / src / transport / plugin_transport_udp.h
index 44791668b3370fc283b3d3f60db3975c72453636..e1ff5e9cf339d233b1e6108036ed07e117d698d0 100644 (file)
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet
-     (C) 2010, 2011 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
@@ -47,6 +47,7 @@
 #define PLUGIN_NAME "udp"
 
 #define DEBUG_UDP GNUNET_NO
+
 #define DEBUG_UDP_BROADCASTING GNUNET_NO
 
 /**
@@ -101,6 +102,23 @@ struct IPv6UdpAddress
 };
 GNUNET_NETWORK_STRUCT_END
 
+/**
+ * Either an IPv4 or IPv6 UDP address.  Note that without a "length",
+ * one cannot tell which one of the two types this address represents.
+ */
+union UdpAddress
+{
+  /**
+   * IPv4 case.
+   */
+  struct IPv4UdpAddress v4;
+
+  /**
+   * IPv6 case.
+   */
+  struct IPv6UdpAddress v6;
+};
+
 
 /**
  * UDP Message-Packet header (after defragmentation).
@@ -126,6 +144,8 @@ struct UDPMessage
 
 struct UDP_MessageWrapper;
 
+struct PrettyPrinterContext;
+
 
 /**
  * Encapsulation of all of the state of the plugin.
@@ -140,7 +160,7 @@ struct Plugin
 
   /**
    * Session of peers with whom we are currently connected,
-   * map of peer identity to 'struct PeerSession'.
+   * map of peer identity to `struct Session *`.
    */
   struct GNUNET_CONTAINER_MultiPeerMap *sessions;
 
@@ -150,10 +170,14 @@ struct Plugin
   struct GNUNET_CONTAINER_Heap *defrag_ctxs;
 
   /**
-   * ID of select task
+   * ID of select task for IPv4
    */
-  GNUNET_SCHEDULER_TaskIdentifier select_task;
-  GNUNET_SCHEDULER_TaskIdentifier select_task_v6;
+  struct GNUNET_SCHEDULER_Task *select_task;
+
+  /**
+   * ID of select task for IPv6
+   */
+  struct GNUNET_SCHEDULER_Task *select_task_v6;
 
   /**
    * Tokenizer for inbound messages.
@@ -175,12 +199,6 @@ struct Plugin
    */
   char *bind6_address;
 
-
-  /**
-   * Bytes currently in buffer
-   */
-  int64_t bytes_in_buffer;
-
   /**
    * Handle to NAT traversal support.
    */
@@ -196,13 +214,11 @@ struct Plugin
    */
   struct GNUNET_NETWORK_FDSet *ws_v4;
 
-
   /**
    * The read socket for IPv4
    */
   struct GNUNET_NETWORK_Handle *sockv4;
 
-
   /**
    * FD Read set
    */
@@ -219,20 +235,59 @@ struct Plugin
   struct GNUNET_NETWORK_Handle *sockv6;
 
   /**
-   * Beacon broadcasting
-   * -------------------
+   * Tokenizer for inbound messages.
    */
+  struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_mst;
 
   /**
-   * Broadcast interval
+   * Head of DLL of broadcast addresses
    */
-  struct GNUNET_TIME_Relative broadcast_interval;
+  struct BroadcastAddress *broadcast_tail;
 
   /**
-   * Tokenizer for inbound messages.
+   * Tail of DLL of broadcast addresses
+   */
+  struct BroadcastAddress *broadcast_head;
+
+  /**
+   * Head of messages in IPv4 queue.
+   */
+  struct UDP_MessageWrapper *ipv4_queue_head;
+
+  /**
+   * Tail of messages in IPv4 queue.
    */
-  struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_ipv6_mst;
-  struct GNUNET_SERVER_MessageStreamTokenizer *broadcast_ipv4_mst;
+  struct UDP_MessageWrapper *ipv4_queue_tail;
+
+  /**
+   * Head of messages in IPv6 queue.
+   */
+  struct UDP_MessageWrapper *ipv6_queue_head;
+
+  /**
+   * Tail of messages in IPv6 queue.
+   */
+  struct UDP_MessageWrapper *ipv6_queue_tail;
+
+  /**
+   * Running pretty printers: head
+   */
+  struct PrettyPrinterContext *ppc_dll_head;
+
+  /**
+   * Running pretty printers: tail
+   */
+  struct PrettyPrinterContext *ppc_dll_tail;
+
+  /**
+   * Function to call about session status changes.
+   */
+  GNUNET_TRANSPORT_SessionInfoCallback sic;
+
+  /**
+   * Closure for @e sic.
+   */
+  void *sic_cls;
 
   /**
    * IPv6 multicast address
@@ -240,28 +295,37 @@ struct Plugin
   struct sockaddr_in6 ipv6_multicast_address;
 
   /**
-   * DLL of broadcast addresses
+   * Broadcast interval
    */
-  struct BroadcastAddress *broadcast_tail;
-  struct BroadcastAddress *broadcast_head;
+  struct GNUNET_TIME_Relative broadcast_interval;
 
   /**
-   * Is IPv6 enabled: GNUNET_YES or GNUNET_NO
+   * Bytes currently in buffer
+   */
+  int64_t bytes_in_buffer;
+
+  /**
+   * Address options
+   */
+  uint32_t myoptions;
+
+  /**
+   * Is IPv6 enabled: #GNUNET_YES or #GNUNET_NO
    */
   int enable_ipv6;
 
   /**
-   * Is IPv4 enabled: GNUNET_YES or GNUNET_NO
+   * Is IPv4 enabled: #GNUNET_YES or #GNUNET_NO
    */
   int enable_ipv4;
 
   /**
-   * Is broadcasting enabled: GNUNET_YES or GNUNET_NO
+   * Is broadcasting enabled: #GNUNET_YES or #GNUNET_NO
    */
   int enable_broadcasting;
 
   /**
-   * Is receiving broadcasts enabled: GNUNET_YES or GNUNET_NO
+   * Is receiving broadcasts enabled: #GNUNET_YES or #GNUNET_NO
    */
   int enable_broadcasting_receiving;
 
@@ -280,29 +344,41 @@ struct Plugin
    */
   uint16_t aport;
 
-  struct UDP_MessageWrapper *ipv4_queue_head;
-  struct UDP_MessageWrapper *ipv4_queue_tail;
-
-  struct UDP_MessageWrapper *ipv6_queue_head;
-  struct UDP_MessageWrapper *ipv6_queue_tail;
 };
 
 
 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);