CK Sin / Mbed 2 deprecated Ethernetwebsocket

Ethernetwebsoc

Dependencies:   C12832_lcd LM75B WebSocketClient mbed-rtos mbed Socket lwip-eth lwip-sys lwip

EthernetInterface/lwip/include/lwip/udp.h@0:0ed2a7c7190c, 2013-05-31 (annotated)

Committer:
GordonSin
Date:
Fri May 31 04:09:54 2013 +0000
Revision:
0:0ed2a7c7190c
31/5/2013;

Who changed what in which revision?

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