2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
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.
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
27 * This file is part of the lwIP TCP/IP stack.
29 * Author: Adam Dunkels <adam@sics.se>
32 #ifndef __LWIP_API_H__
33 #define __LWIP_API_H__
37 #if LWIP_NETCONN /* don't build if not configured for use in lwipopts.h */
39 #include <stddef.h> /* for size_t */
41 #include "lwip/netbuf.h"
43 #include "lwip/ip_addr.h"
50 /* Throughout this file, IP addresses and port numbers are expected to be in
51 * the same byte order as in the corresponding pcb.
54 /* Flags for netconn_write */
55 #define NETCONN_NOFLAG 0x00
56 #define NETCONN_NOCOPY 0x00 /* Only for source code compatibility */
57 #define NETCONN_COPY 0x01
58 #define NETCONN_MORE 0x02
60 /* Helpers to process several netconn_types by the same code */
61 #define NETCONNTYPE_GROUP(t) (t&0xF0)
62 #define NETCONNTYPE_DATAGRAM(t) (t&0xE0)
66 /* NETCONN_TCP Group */
68 /* NETCONN_UDP Group */
70 NETCONN_UDPLITE = 0x21,
71 NETCONN_UDPNOCHKSUM= 0x22,
72 /* NETCONN_RAW Group */
96 #endif /* LWIP_IGMP */
98 /* forward-declare some structs to avoid to include their headers */
105 /** A callback prototype to inform about events for a netconn */
106 typedef void (* netconn_callback)(struct netconn *, enum netconn_evt, u16_t len);
108 /** A netconn descriptor */
110 /** type of the netconn (TCP, UDP or RAW) */
111 enum netconn_type type;
112 /** current state of the netconn */
113 enum netconn_state state;
114 /** the lwIP internal protocol control block */
121 /** the last error this netconn had */
123 /** sem that is used to synchroneously execute functions in the core context */
124 sys_sem_t op_completed;
125 /** mbox where received packets are stored until they are fetched
126 by the netconn application thread (can grow quite big) */
128 /** mbox where new connections are stored until processed
129 by the application thread */
130 sys_mbox_t acceptmbox;
131 /** only used for socket layer */
134 /** timeout to wait for new data to be received
135 (or connections to arrive for listening netconns) */
137 #endif /* LWIP_SO_RCVTIMEO */
139 /** maximum amount of bytes queued in recvmbox */
141 #endif /* LWIP_SO_RCVBUF */
144 /** TCP: when data passed to netconn_write doesn't fit into the send buffer,
145 this temporarily stores the message. */
146 struct api_msg_msg *write_msg;
147 /** TCP: when data passed to netconn_write doesn't fit into the send buffer,
148 this temporarily stores how much is already sent. */
150 #if LWIP_TCPIP_CORE_LOCKING
151 /** TCP: when data passed to netconn_write doesn't fit into the send buffer,
152 this temporarily stores whether to wake up the original application task
153 if data couldn't be sent in the first try. */
155 #endif /* LWIP_TCPIP_CORE_LOCKING */
156 #endif /* LWIP_TCP */
157 /** A callback function that is informed about events for this netconn */
158 netconn_callback callback;
161 /* Register an Network connection event */
162 #define API_EVENT(c,e,l) if (c->callback) { \
163 (*c->callback)(c, e, l); \
166 /* Network connection functions: */
167 #define netconn_new(t) netconn_new_with_proto_and_callback(t, 0, NULL)
168 #define netconn_new_with_callback(t, c) netconn_new_with_proto_and_callback(t, 0, c)
170 netconn *netconn_new_with_proto_and_callback(enum netconn_type t, u8_t proto,
171 netconn_callback callback);
172 err_t netconn_delete (struct netconn *conn);
173 /** Get the type of a netconn (as enum netconn_type). */
174 #define netconn_type(conn) (conn->type)
176 err_t netconn_getaddr (struct netconn *conn,
177 struct ip_addr *addr,
180 #define netconn_peer(c,i,p) netconn_getaddr(c,i,p,0)
181 #define netconn_addr(c,i,p) netconn_getaddr(c,i,p,1)
183 err_t netconn_bind (struct netconn *conn,
184 struct ip_addr *addr,
186 err_t netconn_connect (struct netconn *conn,
187 struct ip_addr *addr,
189 err_t netconn_disconnect (struct netconn *conn);
190 err_t netconn_listen_with_backlog(struct netconn *conn, u8_t backlog);
191 #define netconn_listen(conn) netconn_listen_with_backlog(conn, TCP_DEFAULT_LISTEN_BACKLOG)
192 struct netconn * netconn_accept (struct netconn *conn);
193 struct netbuf * netconn_recv (struct netconn *conn);
194 err_t netconn_sendto (struct netconn *conn,
195 struct netbuf *buf, struct ip_addr *addr, u16_t port);
196 err_t netconn_send (struct netconn *conn,
198 err_t netconn_write (struct netconn *conn,
199 const void *dataptr, size_t size,
201 err_t netconn_close (struct netconn *conn);
204 err_t netconn_join_leave_group (struct netconn *conn,
205 struct ip_addr *multiaddr,
206 struct ip_addr *interface,
207 enum netconn_igmp join_or_leave);
208 #endif /* LWIP_IGMP */
210 err_t netconn_gethostbyname(const char *name, struct ip_addr *addr);
211 #endif /* LWIP_DNS */
213 #define netconn_err(conn) ((conn)->err)
214 #define netconn_recv_bufsize(conn) ((conn)->recv_bufsize)
220 #endif /* LWIP_NETCONN */
222 #endif /* __LWIP_API_H__ */