git.sur5r.net Git - freertos/blob - Demo/lwIP_MCF5235_GCC/lwip/src/include/lwip/udp.h

   1 /*\r
   2  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.\r
   3  * All rights reserved. \r
   4  * \r
   5  * Redistribution and use in source and binary forms, with or without modification, \r
   6  * are permitted provided that the following conditions are met:\r
   7  *\r
   8  * 1. Redistributions of source code must retain the above copyright notice,\r
   9  *    this list of conditions and the following disclaimer.\r
  10  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  11  *    this list of conditions and the following disclaimer in the documentation\r
  12  *    and/or other materials provided with the distribution.\r
  13  * 3. The name of the author may not be used to endorse or promote products\r
  14  *    derived from this software without specific prior written permission. \r
  15  *\r
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED \r
  17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF \r
  18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT \r
  19  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, \r
  20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT \r
  21  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS \r
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN \r
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING \r
  24  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY \r
  25  * OF SUCH DAMAGE.\r
  26  *\r
  27  * This file is part of the lwIP TCP/IP stack.\r
  28  * \r
  29  * Author: Adam Dunkels <adam@sics.se>\r
  30  *\r
  31  */\r
  32 #ifndef __LWIP_UDP_H__\r
  33 #define __LWIP_UDP_H__\r
  34 \r
  35 #include "lwip/arch.h"\r
  36 \r
  37 #include "lwip/pbuf.h"\r
  38 #include "lwip/inet.h"\r
  39 #include "lwip/ip.h"\r
  40 \r
  41 #define UDP_HLEN 8\r
  42 \r
  43 struct udp_hdr {\r
  44   PACK_STRUCT_FIELD(u16_t src);\r
  45   PACK_STRUCT_FIELD(u16_t dest);  /* src/dest UDP ports */\r
  46   PACK_STRUCT_FIELD(u16_t len);\r
  47   PACK_STRUCT_FIELD(u16_t chksum);\r
  48 } PACK_STRUCT_STRUCT;\r
  49 \r
  50 #define UDP_FLAGS_NOCHKSUM 0x01U\r
  51 #define UDP_FLAGS_UDPLITE  0x02U\r
  52 #define UDP_FLAGS_CONNECTED  0x04U\r
  53 \r
  54 struct udp_pcb {\r
  55 /* Common members of all PCB types */\r
  56   IP_PCB;\r
  57 \r
  58 /* Protocol specific PCB members */\r
  59 \r
  60   struct udp_pcb *next;\r
  61 \r
  62   u8_t flags;\r
  63   u16_t local_port, remote_port;\r
  64   \r
  65   u16_t chksum_len;\r
  66   \r
  67   void (* recv)(void *arg, struct udp_pcb *pcb, struct pbuf *p,\r
  68     struct ip_addr *addr, u16_t port);\r
  69   void *recv_arg;  \r
  70 };\r
  71 \r
  72 /* The following functions is the application layer interface to the\r
  73    UDP code. */\r
  74 struct udp_pcb * udp_new        (void);\r
  75 void             udp_remove     (struct udp_pcb *pcb);\r
  76 err_t            udp_bind       (struct udp_pcb *pcb, struct ip_addr *ipaddr,\r
  77                  u16_t port);\r
  78 err_t            udp_connect    (struct udp_pcb *pcb, struct ip_addr *ipaddr,\r
  79                  u16_t port);\r
  80 void             udp_disconnect    (struct udp_pcb *pcb);\r
  81 void             udp_recv       (struct udp_pcb *pcb,\r
  82          void (* recv)(void *arg, struct udp_pcb *upcb,\r
  83                  struct pbuf *p,\r
  84                  struct ip_addr *addr,\r
  85                  u16_t port),\r
  86          void *recv_arg);\r
  87 err_t            udp_sendto     (struct udp_pcb *pcb, struct pbuf *p, struct ip_addr *dst_ip, u16_t dst_port);\r
  88 err_t            udp_send       (struct udp_pcb *pcb, struct pbuf *p);\r
  89 \r
  90 #define          udp_flags(pcb)  ((pcb)->flags)\r
  91 #define          udp_setflags(pcb, f)  ((pcb)->flags = (f))\r
  92 \r
  93 /* The following functions are the lower layer interface to UDP. */\r
  94 void             udp_input      (struct pbuf *p, struct netif *inp);\r
  95 void             udp_init       (void);\r
  96 \r
  97 #if UDP_DEBUG\r
  98 void udp_debug_print(struct udp_hdr *udphdr);\r
  99 #else\r
 100 #define udp_debug_print(udphdr)\r
 101 #endif\r
 102 #endif /* __LWIP_UDP_H__ */\r
 103 \r
 104 \r