src/include/lwip/udp.h

   1 /*
   2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without modification,
   6  * are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  *    this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,
  11  *    this list of conditions and the following disclaimer in the documentation
  12  *    and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  25  * OF SUCH DAMAGE.
  26  *
  27  * This file is part of the lwIP TCP/IP stack.
  28  *
  29  * Author: Adam Dunkels <adam@sics.se>
  30  *
  31  */
  32 #ifndef __LWIP_UDP_H__
  33 #define __LWIP_UDP_H__
  34
  35 #include "lwip/opt.h"
  36
  37 #if LWIP_UDP /* don't build if not configured for use in lwipopts.h */
  38
  39 #include "lwip/pbuf.h"
  40 #include "lwip/inet.h"
  41 #include "lwip/ip.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #define UDP_HLEN 8
  48
  49 /* Fields are (of course) in network byte order. */
  50 #ifdef PACK_STRUCT_USE_INCLUDES
  51 #  include "arch/bpstruct.h"
  52 #endif
  53 PACK_STRUCT_BEGIN
  54 struct udp_hdr {
  55   PACK_STRUCT_FIELD(u16_t src);
  56   PACK_STRUCT_FIELD(u16_t dest);  /* src/dest UDP ports */
  57   PACK_STRUCT_FIELD(u16_t len);
  58   PACK_STRUCT_FIELD(u16_t chksum);
  59 } PACK_STRUCT_STRUCT;
  60 PACK_STRUCT_END
  61 #ifdef PACK_STRUCT_USE_INCLUDES
  62 #  include "arch/epstruct.h"
  63 #endif
  64
  65 #define UDP_FLAGS_NOCHKSUM 0x01U
  66 #define UDP_FLAGS_UDPLITE  0x02U
  67 #define UDP_FLAGS_CONNECTED  0x04U
  68
  69 struct udp_pcb {
  70 /* Common members of all PCB types */
  71   IP_PCB;
  72
  73 /* Protocol specific PCB members */
  74
  75   struct udp_pcb *next;
  76
  77   u8_t flags;
  78   /* ports are in host byte order */
  79   u16_t local_port, remote_port;
  80
  81 #if LWIP_IGMP
  82   /* outgoing network interface for multicast packets */
  83   struct ip_addr multicast_ip;
  84 #endif /* LWIP_IGMP */
  85
  86 #if LWIP_UDPLITE
  87   /* used for UDP_LITE only */
  88   u16_t chksum_len_rx, chksum_len_tx;
  89 #endif /* LWIP_UDPLITE */
  90
  91   /* receive callback function
  92    * addr and port are in same byte order as in the pcb
  93    * The callback is responsible for freeing the pbuf
  94    * if it's not used any more.
  95    *
  96    * @param arg user supplied argument (udp_pcb.recv_arg)
  97    * @param pcb the udp_pcb which received data
  98    * @param p the packet buffer that was received
  99    * @param addr the remote IP address from which the packet was received
 100    * @param port the remote port from which the packet was received
 101    */
 102   void (* recv)(void *arg, struct udp_pcb *pcb, struct pbuf *p,
 103     struct ip_addr *addr, u16_t port);
 104   /* user-supplied argument for the recv callback */
 105   void *recv_arg;
 106 };
 107 /* udp_pcbs export for exernal reference (e.g. SNMP agent) */
 108 extern struct udp_pcb *udp_pcbs;
 109
 110 /* The following functions is the application layer interface to the
 111    UDP code. */
 112 struct udp_pcb * udp_new        (void);
 113 void             udp_remove     (struct udp_pcb *pcb);
 114 err_t            udp_bind       (struct udp_pcb *pcb, struct ip_addr *ipaddr,
 115                  u16_t port);
 116 err_t            udp_connect    (struct udp_pcb *pcb, struct ip_addr *ipaddr,
 117                  u16_t port);
 118 void             udp_disconnect    (struct udp_pcb *pcb);
 119 void             udp_recv       (struct udp_pcb *pcb,
 120          void (* recv)(void *arg, struct udp_pcb *upcb,
 121                  struct pbuf *p,
 122                  struct ip_addr *addr,
 123                  u16_t port),
 124          void *recv_arg);
 125 err_t            udp_sendto     (struct udp_pcb *pcb, struct pbuf *p, struct ip_addr *dst_ip, u16_t dst_port);
 126 err_t            udp_send       (struct udp_pcb *pcb, struct pbuf *p);
 127
 128 #define          udp_flags(pcb)  ((pcb)->flags)
 129 #define          udp_setflags(pcb, f)  ((pcb)->flags = (f))
 130
 131 /* The following functions are the lower layer interface to UDP. */
 132 void             udp_input      (struct pbuf *p, struct netif *inp);
 133 void             udp_init       (void);
 134
 135 #if UDP_DEBUG
 136 void udp_debug_print(struct udp_hdr *udphdr);
 137 #else
 138 #define udp_debug_print(udphdr)
 139 #endif
 140
 141 #ifdef __cplusplus
 142 }
 143 #endif
 144
 145 #endif /* LWIP_UDP */
 146
 147 #endif /* __LWIP_UDP_H__ */