ReactOS 0.4.16-dev-747-gbc52d5f
udp.h
Go to the documentation of this file.
1
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
53extern "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
61struct udp_pcb;
62
77typedef void (*udp_recv_fn)(void *arg, struct udp_pcb *pcb, struct pbuf *p,
78 const ip_addr_t *addr, u16_t port);
79
81struct udp_pcb {
83 IP_PCB;
84
85/* Protocol specific PCB members */
86
87 struct udp_pcb *next;
88
89 u8_t flags;
91 u16_t local_port, remote_port;
92
93#if LWIP_MULTICAST_TX_OPTIONS
94#if LWIP_IPV4
96 ip4_addr_t mcast_ip4;
97#endif /* LWIP_IPV4 */
99 u8_t mcast_ifindex;
101 u8_t mcast_ttl;
102#endif /* LWIP_MULTICAST_TX_OPTIONS */
103
104#if LWIP_UDPLITE
106 u16_t chksum_len_rx, chksum_len_tx;
107#endif /* LWIP_UDPLITE */
108
110 udp_recv_fn recv;
112 void *recv_arg;
113};
114/* udp_pcbs export for external reference (e.g. SNMP agent) */
115extern struct udp_pcb *udp_pcbs;
116
117/* The following functions is the application layer interface to the
118 UDP code. */
119struct udp_pcb * udp_new (void);
120struct udp_pcb * udp_new_ip_type(u8_t type);
121void udp_remove (struct udp_pcb *pcb);
122err_t udp_bind (struct udp_pcb *pcb, const ip_addr_t *ipaddr,
123 u16_t port);
124void udp_bind_netif (struct udp_pcb *pcb, const struct netif* netif);
125err_t udp_connect (struct udp_pcb *pcb, const ip_addr_t *ipaddr,
126 u16_t port);
127void udp_disconnect (struct udp_pcb *pcb);
128void udp_recv (struct udp_pcb *pcb, udp_recv_fn recv,
129 void *recv_arg);
130err_t udp_sendto_if (struct udp_pcb *pcb, struct pbuf *p,
131 const ip_addr_t *dst_ip, u16_t dst_port,
132 struct netif *netif);
133err_t udp_sendto_if_src(struct udp_pcb *pcb, struct pbuf *p,
134 const ip_addr_t *dst_ip, u16_t dst_port,
135 struct netif *netif, const ip_addr_t *src_ip);
136err_t udp_sendto (struct udp_pcb *pcb, struct pbuf *p,
137 const ip_addr_t *dst_ip, u16_t dst_port);
138err_t udp_send (struct udp_pcb *pcb, struct pbuf *p);
139
140#if LWIP_CHECKSUM_ON_COPY && CHECKSUM_GEN_UDP
141err_t udp_sendto_if_chksum(struct udp_pcb *pcb, struct pbuf *p,
142 const ip_addr_t *dst_ip, u16_t dst_port,
143 struct netif *netif, u8_t have_chksum,
144 u16_t chksum);
145err_t udp_sendto_chksum(struct udp_pcb *pcb, struct pbuf *p,
146 const ip_addr_t *dst_ip, u16_t dst_port,
147 u8_t have_chksum, u16_t chksum);
148err_t udp_send_chksum(struct udp_pcb *pcb, struct pbuf *p,
149 u8_t have_chksum, u16_t chksum);
150err_t udp_sendto_if_src_chksum(struct udp_pcb *pcb, struct pbuf *p,
151 const ip_addr_t *dst_ip, u16_t dst_port, struct netif *netif,
152 u8_t have_chksum, u16_t chksum, const ip_addr_t *src_ip);
153#endif /* LWIP_CHECKSUM_ON_COPY && CHECKSUM_GEN_UDP */
154
155#define udp_flags(pcb) ((pcb)->flags)
156#define udp_setflags(pcb, f) ((pcb)->flags = (f))
157
158#define udp_set_flags(pcb, set_flags) do { (pcb)->flags = (u8_t)((pcb)->flags | (set_flags)); } while(0)
159#define udp_clear_flags(pcb, clr_flags) do { (pcb)->flags = (u8_t)((pcb)->flags & (u8_t)(~(clr_flags) & 0xff)); } while(0)
160#define udp_is_flag_set(pcb, flag) (((pcb)->flags & (flag)) != 0)
161
162/* The following functions are the lower layer interface to UDP. */
163void udp_input (struct pbuf *p, struct netif *inp);
164
165void udp_init (void);
166
167/* for compatibility with older implementation */
168#define udp_new_ip6() udp_new_ip_type(IPADDR_TYPE_V6)
169
170#if LWIP_MULTICAST_TX_OPTIONS
171#if LWIP_IPV4
172#define udp_set_multicast_netif_addr(pcb, ip4addr) ip4_addr_copy((pcb)->mcast_ip4, *(ip4addr))
173#define udp_get_multicast_netif_addr(pcb) (&(pcb)->mcast_ip4)
174#endif /* LWIP_IPV4 */
175#define udp_set_multicast_netif_index(pcb, idx) ((pcb)->mcast_ifindex = (idx))
176#define udp_get_multicast_netif_index(pcb) ((pcb)->mcast_ifindex)
177#define udp_set_multicast_ttl(pcb, value) ((pcb)->mcast_ttl = (value))
178#define udp_get_multicast_ttl(pcb) ((pcb)->mcast_ttl)
179#endif /* LWIP_MULTICAST_TX_OPTIONS */
180
181#if UDP_DEBUG
182void udp_debug_print(struct udp_hdr *udphdr);
183#else
184#define udp_debug_print(udphdr)
185#endif
186
187void udp_netif_ip_addr_changed(const ip_addr_t* old_addr, const ip_addr_t* new_addr);
188
189#ifdef __cplusplus
190}
191#endif
192
193#endif /* LWIP_UDP */
194
195#endif /* LWIP_HDR_UDP_H */
USHORT port
Definition: uri.c:228
INT WSAAPI recv(IN SOCKET s, OUT CHAR FAR *buf, IN INT len, IN INT flags)
Definition: recv.c:23
#define IP_PCB
Definition: ip.h:76
GLuint GLuint GLsizei GLenum type
Definition: gl.h:1545
GLbitfield flags
Definition: glext.h:7161
GLenum const GLvoid * addr
Definition: glext.h:9621
GLfloat GLfloat p
Definition: glext.h:8902
uint8_t u8_t
Definition: arch.h:125
uint16_t u16_t
Definition: arch.h:127
s8_t err_t
Definition: err.h:96
ip6_addr_t ip_addr_t
Definition: ip_addr.h:344
static unsigned __int64 next
Definition: rand_nt.c:6
Definition: netif.h:269
Definition: pbuf.h:186
Definition: udp.h:53
Definition: dhcpd.h:79
void * arg
Definition: msvc.h:10