third_party/lwip/repo/lwip/src/include/lwip/udp.h

   1 /**
   2  * @file
   3  * UDP API (to be used from TCPIP thread)\n
   4  * See also @ref udp_raw
   5  */
   6
   7 /*
   8  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without modification,
  12  * are permitted provided that the following conditions are met:
  13  *
  14  * 1. Redistributions of source code must retain the above copyright notice,
  15  *    this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright notice,
  17  *    this list of conditions and the following disclaimer in the documentation
  18  *    and/or other materials provided with the distribution.
  19  * 3. The name of the author may not be used to endorse or promote products
  20  *    derived from this software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  23  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  24  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  25  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  26  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  27  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  30  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  31  * OF SUCH DAMAGE.
  32  *
  33  * This file is part of the lwIP TCP/IP stack.
  34  *
  35  * Author: Adam Dunkels <adam@sics.se>
  36  *
  37  */
  38 #ifndef LWIP_HDR_UDP_H
  39 #define LWIP_HDR_UDP_H
  40
  41 #include "lwip/opt.h"
  42
  43 #if LWIP_UDP /* don't build if not configured for use in lwipopts.h */
  44
  45 #include "lwip/pbuf.h"
  46 #include "lwip/netif.h"
  47 #include "lwip/ip_addr.h"
  48 #include "lwip/ip.h"
  49 #include "lwip/ip6_addr.h"
  50 #include "lwip/prot/udp.h"
  51
  52 #ifdef __cplusplus
  53 extern "C" {
  54 #endif
  55
  56 #define UDP_FLAGS_NOCHKSUM       0x01U
  57 #define UDP_FLAGS_UDPLITE        0x02U
  58 #define UDP_FLAGS_CONNECTED      0x04U
  59 #define UDP_FLAGS_MULTICAST_LOOP 0x08U
  60
  61 struct udp_pcb;
  62
  63 /** Function prototype for udp pcb receive callback functions
  64  * addr and port are in same byte order as in the pcb
  65  * The callback is responsible for freeing the pbuf
  66  * if it's not used any more.
  67  *
  68  * ATTENTION: Be aware that 'addr' might point into the pbuf 'p' so freeing this pbuf
  69  *            can make 'addr' invalid, too.
  70  *
  71  * @param arg user supplied argument (udp_pcb.recv_arg)
  72  * @param pcb the udp_pcb which received data
  73  * @param p the packet buffer that was received
  74  * @param addr the remote IP address from which the packet was received
  75  * @param port the remote port from which the packet was received
  76  */
  77 typedef void (*udp_recv_fn)(void *arg, struct udp_pcb *pcb, struct pbuf *p,
  78     const ip_addr_t *addr, u16_t port);
  79
  80 /** the UDP protocol control block */
  81 struct udp_pcb {
  82 /** Common members of all PCB types */
  83   IP_PCB;
  84
  85 /* Protocol specific PCB members */
  86
  87   struct udp_pcb *next;
  88   struct netif *intf_filter;
  89
  90   u8_t flags;
  91   /** ports are in host byte order */
  92   u16_t local_port, remote_port;
  93
  94 #if LWIP_MULTICAST_TX_OPTIONS
  95 #if LWIP_IPV4
  96   /** outgoing network interface for multicast packets, by IPv4 address (if not 'any') */
  97   ip4_addr_t mcast_ip4;
  98 #endif /* LWIP_IPV4 */
  99   /** outgoing network interface for multicast packets, by interface index (if nonzero) */
 100   u8_t mcast_ifindex;
 101   /** TTL for outgoing multicast packets */
 102   u8_t mcast_ttl;
 103 #endif /* LWIP_MULTICAST_TX_OPTIONS */
 104
 105 #if LWIP_UDPLITE
 106   /** used for UDP_LITE only */
 107   u16_t chksum_len_rx, chksum_len_tx;
 108 #endif /* LWIP_UDPLITE */
 109
 110   /** receive callback function */
 111   udp_recv_fn recv;
 112   /** user-supplied argument for the recv callback */
 113   void *recv_arg;
 114 };
 115 /* udp_pcbs export for external reference (e.g. SNMP agent) */
 116 extern struct udp_pcb *udp_pcbs;
 117
 118 /* The following functions is the application layer interface to the
 119    UDP code. */
 120 struct udp_pcb * udp_new        (void);
 121 struct udp_pcb * udp_new_ip_type(u8_t type);
 122 void             udp_remove     (struct udp_pcb *pcb);
 123 err_t            udp_bind       (struct udp_pcb *pcb, const ip_addr_t *ipaddr,
 124                                  u16_t port);
 125 void             udp_bind_netif (struct udp_pcb *pcb, const struct netif* netif);
 126 err_t            udp_connect    (struct udp_pcb *pcb, const ip_addr_t *ipaddr,
 127                                  u16_t port);
 128 void             udp_disconnect (struct udp_pcb *pcb);
 129 void             udp_recv       (struct udp_pcb *pcb, udp_recv_fn recv,
 130                                  void *recv_arg);
 131 err_t            udp_sendto_if  (struct udp_pcb *pcb, struct pbuf *p,
 132                                  const ip_addr_t *dst_ip, u16_t dst_port,
 133                                  struct netif *netif);
 134 err_t            udp_sendto_if_src(struct udp_pcb *pcb, struct pbuf *p,
 135                                  const ip_addr_t *dst_ip, u16_t dst_port,
 136                                  struct netif *netif, const ip_addr_t *src_ip);
 137 err_t            udp_sendto     (struct udp_pcb *pcb, struct pbuf *p,
 138                                  const ip_addr_t *dst_ip, u16_t dst_port);
 139 err_t            udp_send       (struct udp_pcb *pcb, struct pbuf *p);
 140
 141 #if LWIP_CHECKSUM_ON_COPY && CHECKSUM_GEN_UDP
 142 err_t            udp_sendto_if_chksum(struct udp_pcb *pcb, struct pbuf *p,
 143                                  const ip_addr_t *dst_ip, u16_t dst_port,
 144                                  struct netif *netif, u8_t have_chksum,
 145                                  u16_t chksum);
 146 err_t            udp_sendto_chksum(struct udp_pcb *pcb, struct pbuf *p,
 147                                  const ip_addr_t *dst_ip, u16_t dst_port,
 148                                  u8_t have_chksum, u16_t chksum);
 149 err_t            udp_send_chksum(struct udp_pcb *pcb, struct pbuf *p,
 150                                  u8_t have_chksum, u16_t chksum);
 151 err_t            udp_sendto_if_src_chksum(struct udp_pcb *pcb, struct pbuf *p,
 152                                  const ip_addr_t *dst_ip, u16_t dst_port, struct netif *netif,
 153                                  u8_t have_chksum, u16_t chksum, const ip_addr_t *src_ip);
 154 #endif /* LWIP_CHECKSUM_ON_COPY && CHECKSUM_GEN_UDP */
 155
 156 #define          udp_flags(pcb) ((pcb)->flags)
 157 #define          udp_setflags(pcb, f)  ((pcb)->flags = (f))
 158
 159 #define          udp_set_flags(pcb, set_flags)     do { (pcb)->flags = (u8_t)((pcb)->flags |  (set_flags)); } while(0)
 160 #define          udp_clear_flags(pcb, clr_flags)   do { (pcb)->flags = (u8_t)((pcb)->flags & ~(clr_flags)); } while(0)
 161 #define          udp_is_flag_set(pcb, flag)        (((pcb)->flags & (flag)) != 0)
 162
 163 /* The following functions are the lower layer interface to UDP. */
 164 void             udp_input      (struct pbuf *p, struct netif *inp);
 165
 166 void             udp_init       (void);
 167
 168 /* for compatibility with older implementation */
 169 #define udp_new_ip6() udp_new_ip_type(IPADDR_TYPE_V6)
 170
 171 #if LWIP_MULTICAST_TX_OPTIONS
 172 #if LWIP_IPV4
 173 #define udp_set_multicast_netif_addr(pcb, ip4addr) ip4_addr_copy((pcb)->mcast_ip4, *(ip4addr))
 174 #define udp_get_multicast_netif_addr(pcb)          (&(pcb)->mcast_ip4)
 175 #endif /* LWIP_IPV4 */
 176 #define udp_set_multicast_netif_index(pcb, idx)    ((pcb)->mcast_ifindex = (idx))
 177 #define udp_get_multicast_netif_index(pcb)         ((pcb)->mcast_ifindex)
 178 #define udp_set_multicast_ttl(pcb, value)          ((pcb)->mcast_ttl = (value))
 179 #define udp_get_multicast_ttl(pcb)                 ((pcb)->mcast_ttl)
 180 #endif /* LWIP_MULTICAST_TX_OPTIONS */
 181
 182 #if UDP_DEBUG
 183 void udp_debug_print(struct udp_hdr *udphdr);
 184 #else
 185 #define udp_debug_print(udphdr)
 186 #endif
 187
 188 void udp_netif_ip_addr_changed(const ip_addr_t* old_addr, const ip_addr_t* new_addr);
 189
 190 #ifdef __cplusplus
 191 }
 192 #endif
 193
 194 #endif /* LWIP_UDP */
 195
 196 #endif /* LWIP_HDR_UDP_H */