This library is deprecated.

Dependents:   HTTPClientStreamingExample HTTPClientExample HTTPServerExample HTTPServerHelloWorld ... more

Committer:
donatien
Date:
Thu Aug 05 15:09:22 2010 +0000
Revision:
5:bc7df6da7589
Parent:
0:422060928e37

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:422060928e37 1 /*
donatien 0:422060928e37 2 * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
donatien 0:422060928e37 3 * All rights reserved.
donatien 0:422060928e37 4 *
donatien 0:422060928e37 5 * Redistribution and use in source and binary forms, with or without modification,
donatien 0:422060928e37 6 * are permitted provided that the following conditions are met:
donatien 0:422060928e37 7 *
donatien 0:422060928e37 8 * 1. Redistributions of source code must retain the above copyright notice,
donatien 0:422060928e37 9 * this list of conditions and the following disclaimer.
donatien 0:422060928e37 10 * 2. Redistributions in binary form must reproduce the above copyright notice,
donatien 0:422060928e37 11 * this list of conditions and the following disclaimer in the documentation
donatien 0:422060928e37 12 * and/or other materials provided with the distribution.
donatien 0:422060928e37 13 * 3. The name of the author may not be used to endorse or promote products
donatien 0:422060928e37 14 * derived from this software without specific prior written permission.
donatien 0:422060928e37 15 *
donatien 0:422060928e37 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
donatien 0:422060928e37 17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
donatien 0:422060928e37 18 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
donatien 0:422060928e37 19 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
donatien 0:422060928e37 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
donatien 0:422060928e37 21 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
donatien 0:422060928e37 22 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
donatien 0:422060928e37 23 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
donatien 0:422060928e37 24 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
donatien 0:422060928e37 25 * OF SUCH DAMAGE.
donatien 0:422060928e37 26 *
donatien 0:422060928e37 27 * This file is part of the lwIP TCP/IP stack.
donatien 0:422060928e37 28 *
donatien 0:422060928e37 29 * Author: Adam Dunkels <adam@sics.se>
donatien 0:422060928e37 30 *
donatien 0:422060928e37 31 */
donatien 0:422060928e37 32 #ifndef __LWIP_API_H__
donatien 0:422060928e37 33 #define __LWIP_API_H__
donatien 0:422060928e37 34
donatien 0:422060928e37 35 #include "lwip/opt.h"
donatien 0:422060928e37 36
donatien 0:422060928e37 37 #if LWIP_NETCONN /* don't build if not configured for use in lwipopts.h */
donatien 0:422060928e37 38
donatien 0:422060928e37 39 #include <stddef.h> /* for size_t */
donatien 0:422060928e37 40
donatien 0:422060928e37 41 #include "lwip/netbuf.h"
donatien 0:422060928e37 42 #include "lwip/sys.h"
donatien 0:422060928e37 43 #include "lwip/ip_addr.h"
donatien 0:422060928e37 44 #include "lwip/err.h"
donatien 0:422060928e37 45
donatien 0:422060928e37 46 #ifdef __cplusplus
donatien 0:422060928e37 47 extern "C" {
donatien 0:422060928e37 48 #endif
donatien 0:422060928e37 49
donatien 0:422060928e37 50 /* Throughout this file, IP addresses and port numbers are expected to be in
donatien 0:422060928e37 51 * the same byte order as in the corresponding pcb.
donatien 0:422060928e37 52 */
donatien 0:422060928e37 53
donatien 0:422060928e37 54 /* Flags for netconn_write (u8_t) */
donatien 0:422060928e37 55 #define NETCONN_NOFLAG 0x00
donatien 0:422060928e37 56 #define NETCONN_NOCOPY 0x00 /* Only for source code compatibility */
donatien 0:422060928e37 57 #define NETCONN_COPY 0x01
donatien 0:422060928e37 58 #define NETCONN_MORE 0x02
donatien 0:422060928e37 59 #define NETCONN_DONTBLOCK 0x04
donatien 0:422060928e37 60
donatien 0:422060928e37 61 /* Flags for struct netconn.flags (u8_t) */
donatien 0:422060928e37 62 /** TCP: when data passed to netconn_write doesn't fit into the send buffer,
donatien 0:422060928e37 63 this temporarily stores whether to wake up the original application task
donatien 0:422060928e37 64 if data couldn't be sent in the first try. */
donatien 0:422060928e37 65 #define NETCONN_FLAG_WRITE_DELAYED 0x01
donatien 0:422060928e37 66 /** Should this netconn avoid blocking? */
donatien 0:422060928e37 67 #define NETCONN_FLAG_NON_BLOCKING 0x02
donatien 0:422060928e37 68 /** Was the last connect action a non-blocking one? */
donatien 0:422060928e37 69 #define NETCONN_FLAG_IN_NONBLOCKING_CONNECT 0x04
donatien 0:422060928e37 70 /** If this is set, a TCP netconn must call netconn_recved() to update
donatien 0:422060928e37 71 the TCP receive window (done automatically if not set). */
donatien 0:422060928e37 72 #define NETCONN_FLAG_NO_AUTO_RECVED 0x08
donatien 0:422060928e37 73 /** If a nonblocking write has been rejected before, poll_tcp needs to
donatien 0:422060928e37 74 check if the netconn is writable again */
donatien 0:422060928e37 75 #define NETCONN_FLAG_CHECK_WRITESPACE 0x10
donatien 0:422060928e37 76
donatien 0:422060928e37 77
donatien 0:422060928e37 78 /* Helpers to process several netconn_types by the same code */
donatien 0:422060928e37 79 #define NETCONNTYPE_GROUP(t) (t&0xF0)
donatien 0:422060928e37 80 #define NETCONNTYPE_DATAGRAM(t) (t&0xE0)
donatien 0:422060928e37 81
donatien 0:422060928e37 82 /** Protocol family and type of the netconn */
donatien 0:422060928e37 83 enum netconn_type {
donatien 0:422060928e37 84 NETCONN_INVALID = 0,
donatien 0:422060928e37 85 /* NETCONN_TCP Group */
donatien 0:422060928e37 86 NETCONN_TCP = 0x10,
donatien 0:422060928e37 87 /* NETCONN_UDP Group */
donatien 0:422060928e37 88 NETCONN_UDP = 0x20,
donatien 0:422060928e37 89 NETCONN_UDPLITE = 0x21,
donatien 0:422060928e37 90 NETCONN_UDPNOCHKSUM= 0x22,
donatien 0:422060928e37 91 /* NETCONN_RAW Group */
donatien 0:422060928e37 92 NETCONN_RAW = 0x40
donatien 0:422060928e37 93 };
donatien 0:422060928e37 94
donatien 0:422060928e37 95 /** Current state of the netconn. Non-TCP netconns are always
donatien 0:422060928e37 96 * in state NETCONN_NONE! */
donatien 0:422060928e37 97 enum netconn_state {
donatien 0:422060928e37 98 NETCONN_NONE,
donatien 0:422060928e37 99 NETCONN_WRITE,
donatien 0:422060928e37 100 NETCONN_LISTEN,
donatien 0:422060928e37 101 NETCONN_CONNECT,
donatien 0:422060928e37 102 NETCONN_CLOSE
donatien 0:422060928e37 103 };
donatien 0:422060928e37 104
donatien 0:422060928e37 105 /** Use to inform the callback function about changes */
donatien 0:422060928e37 106 enum netconn_evt {
donatien 0:422060928e37 107 NETCONN_EVT_RCVPLUS,
donatien 0:422060928e37 108 NETCONN_EVT_RCVMINUS,
donatien 0:422060928e37 109 NETCONN_EVT_SENDPLUS,
donatien 0:422060928e37 110 NETCONN_EVT_SENDMINUS,
donatien 0:422060928e37 111 NETCONN_EVT_ERROR
donatien 0:422060928e37 112 };
donatien 0:422060928e37 113
donatien 0:422060928e37 114 #if LWIP_IGMP
donatien 0:422060928e37 115 /** Used for netconn_join_leave_group() */
donatien 0:422060928e37 116 enum netconn_igmp {
donatien 0:422060928e37 117 NETCONN_JOIN,
donatien 0:422060928e37 118 NETCONN_LEAVE
donatien 0:422060928e37 119 };
donatien 0:422060928e37 120 #endif /* LWIP_IGMP */
donatien 0:422060928e37 121
donatien 0:422060928e37 122 /* forward-declare some structs to avoid to include their headers */
donatien 0:422060928e37 123 struct ip_pcb;
donatien 0:422060928e37 124 struct tcp_pcb;
donatien 0:422060928e37 125 struct udp_pcb;
donatien 0:422060928e37 126 struct raw_pcb;
donatien 0:422060928e37 127 struct netconn;
donatien 0:422060928e37 128 struct api_msg_msg;
donatien 0:422060928e37 129
donatien 0:422060928e37 130 /** A callback prototype to inform about events for a netconn */
donatien 0:422060928e37 131 typedef void (* netconn_callback)(struct netconn *, enum netconn_evt, u16_t len);
donatien 0:422060928e37 132
donatien 0:422060928e37 133 /** A netconn descriptor */
donatien 0:422060928e37 134 struct netconn {
donatien 0:422060928e37 135 /** type of the netconn (TCP, UDP or RAW) */
donatien 0:422060928e37 136 enum netconn_type type;
donatien 0:422060928e37 137 /** current state of the netconn */
donatien 0:422060928e37 138 enum netconn_state state;
donatien 0:422060928e37 139 /** the lwIP internal protocol control block */
donatien 0:422060928e37 140 union {
donatien 0:422060928e37 141 struct ip_pcb *ip;
donatien 0:422060928e37 142 struct tcp_pcb *tcp;
donatien 0:422060928e37 143 struct udp_pcb *udp;
donatien 0:422060928e37 144 struct raw_pcb *raw;
donatien 0:422060928e37 145 } pcb;
donatien 0:422060928e37 146 /** the last error this netconn had */
donatien 0:422060928e37 147 err_t last_err;
donatien 0:422060928e37 148 /** sem that is used to synchroneously execute functions in the core context */
donatien 0:422060928e37 149 sys_sem_t op_completed;
donatien 0:422060928e37 150 /** mbox where received packets are stored until they are fetched
donatien 0:422060928e37 151 by the netconn application thread (can grow quite big) */
donatien 0:422060928e37 152 sys_mbox_t recvmbox;
donatien 5:bc7df6da7589 153 #if LWIP_TCP
donatien 0:422060928e37 154 /** mbox where new connections are stored until processed
donatien 0:422060928e37 155 by the application thread */
donatien 0:422060928e37 156 sys_mbox_t acceptmbox;
donatien 5:bc7df6da7589 157 #endif /* LWIP_TCP */
donatien 0:422060928e37 158 /** only used for socket layer */
donatien 0:422060928e37 159 #if LWIP_SOCKET
donatien 0:422060928e37 160 int socket;
donatien 0:422060928e37 161 #endif /* LWIP_SOCKET */
donatien 0:422060928e37 162 #if LWIP_SO_RCVTIMEO
donatien 0:422060928e37 163 /** timeout to wait for new data to be received
donatien 0:422060928e37 164 (or connections to arrive for listening netconns) */
donatien 0:422060928e37 165 int recv_timeout;
donatien 0:422060928e37 166 #endif /* LWIP_SO_RCVTIMEO */
donatien 0:422060928e37 167 #if LWIP_SO_RCVBUF
donatien 0:422060928e37 168 /** maximum amount of bytes queued in recvmbox
donatien 0:422060928e37 169 not used for TCP: adjust TCP_WND instead! */
donatien 0:422060928e37 170 int recv_bufsize;
donatien 0:422060928e37 171 #endif /* LWIP_SO_RCVBUF */
donatien 0:422060928e37 172 /** number of bytes currently in recvmbox to be received,
donatien 0:422060928e37 173 tested against recv_bufsize to limit bytes on recvmbox
donatien 0:422060928e37 174 for UDP and RAW
donatien 0:422060928e37 175 @todo: should only be necessary with LWIP_SO_RCVBUF==1 */
donatien 0:422060928e37 176 s16_t recv_avail;
donatien 0:422060928e37 177 /** flags holding more netconn-internal state, see NETCONN_FLAG_* defines */
donatien 0:422060928e37 178 u8_t flags;
donatien 0:422060928e37 179 #if LWIP_TCP
donatien 0:422060928e37 180 /** TCP: when data passed to netconn_write doesn't fit into the send buffer,
donatien 0:422060928e37 181 this temporarily stores how much is already sent. */
donatien 0:422060928e37 182 size_t write_offset;
donatien 0:422060928e37 183 /** TCP: when data passed to netconn_write doesn't fit into the send buffer,
donatien 0:422060928e37 184 this temporarily stores the message.
donatien 0:422060928e37 185 Also used during connect and close. */
donatien 0:422060928e37 186 struct api_msg_msg *current_msg;
donatien 0:422060928e37 187 #endif /* LWIP_TCP */
donatien 0:422060928e37 188 /** A callback function that is informed about events for this netconn */
donatien 0:422060928e37 189 netconn_callback callback;
donatien 0:422060928e37 190 };
donatien 0:422060928e37 191
donatien 0:422060928e37 192 /** Register an Network connection event */
donatien 0:422060928e37 193 #define API_EVENT(c,e,l) if (c->callback) { \
donatien 0:422060928e37 194 (*c->callback)(c, e, l); \
donatien 0:422060928e37 195 }
donatien 0:422060928e37 196
donatien 0:422060928e37 197 /** Set conn->last_err to err but don't overwrite fatal errors */
donatien 0:422060928e37 198 #define NETCONN_SET_SAFE_ERR(conn, err) do { \
donatien 0:422060928e37 199 SYS_ARCH_DECL_PROTECT(lev); \
donatien 0:422060928e37 200 SYS_ARCH_PROTECT(lev); \
donatien 0:422060928e37 201 if (!ERR_IS_FATAL((conn)->last_err)) { \
donatien 0:422060928e37 202 (conn)->last_err = err; \
donatien 0:422060928e37 203 } \
donatien 0:422060928e37 204 SYS_ARCH_UNPROTECT(lev); \
donatien 0:422060928e37 205 } while(0);
donatien 0:422060928e37 206
donatien 0:422060928e37 207 /* Network connection functions: */
donatien 0:422060928e37 208 #define netconn_new(t) netconn_new_with_proto_and_callback(t, 0, NULL)
donatien 0:422060928e37 209 #define netconn_new_with_callback(t, c) netconn_new_with_proto_and_callback(t, 0, c)
donatien 0:422060928e37 210 struct
donatien 0:422060928e37 211 netconn *netconn_new_with_proto_and_callback(enum netconn_type t, u8_t proto,
donatien 0:422060928e37 212 netconn_callback callback);
donatien 0:422060928e37 213 err_t netconn_delete(struct netconn *conn);
donatien 0:422060928e37 214 /** Get the type of a netconn (as enum netconn_type). */
donatien 0:422060928e37 215 #define netconn_type(conn) (conn->type)
donatien 0:422060928e37 216
donatien 0:422060928e37 217 err_t netconn_getaddr(struct netconn *conn, ip_addr_t *addr,
donatien 0:422060928e37 218 u16_t *port, u8_t local);
donatien 0:422060928e37 219 #define netconn_peer(c,i,p) netconn_getaddr(c,i,p,0)
donatien 0:422060928e37 220 #define netconn_addr(c,i,p) netconn_getaddr(c,i,p,1)
donatien 0:422060928e37 221
donatien 0:422060928e37 222 err_t netconn_bind(struct netconn *conn, ip_addr_t *addr, u16_t port);
donatien 0:422060928e37 223 err_t netconn_connect(struct netconn *conn, ip_addr_t *addr, u16_t port);
donatien 0:422060928e37 224 err_t netconn_disconnect (struct netconn *conn);
donatien 0:422060928e37 225 err_t netconn_listen_with_backlog(struct netconn *conn, u8_t backlog);
donatien 0:422060928e37 226 #define netconn_listen(conn) netconn_listen_with_backlog(conn, TCP_DEFAULT_LISTEN_BACKLOG)
donatien 0:422060928e37 227 err_t netconn_accept(struct netconn *conn, struct netconn **new_conn);
donatien 0:422060928e37 228 err_t netconn_recv(struct netconn *conn, struct netbuf **new_buf);
donatien 0:422060928e37 229 err_t netconn_recv_tcp_pbuf(struct netconn *conn, struct pbuf **new_buf);
donatien 0:422060928e37 230 void netconn_recved(struct netconn *conn, u32_t length);
donatien 0:422060928e37 231 err_t netconn_sendto(struct netconn *conn, struct netbuf *buf,
donatien 0:422060928e37 232 ip_addr_t *addr, u16_t port);
donatien 0:422060928e37 233 err_t netconn_send(struct netconn *conn, struct netbuf *buf);
donatien 0:422060928e37 234 err_t netconn_write(struct netconn *conn, const void *dataptr, size_t size,
donatien 0:422060928e37 235 u8_t apiflags);
donatien 0:422060928e37 236 err_t netconn_close(struct netconn *conn);
donatien 5:bc7df6da7589 237 err_t netconn_shutdown(struct netconn *conn, u8_t shut_rx, u8_t shut_tx);
donatien 0:422060928e37 238
donatien 0:422060928e37 239 #if LWIP_IGMP
donatien 0:422060928e37 240 err_t netconn_join_leave_group(struct netconn *conn, ip_addr_t *multiaddr,
donatien 0:422060928e37 241 ip_addr_t *netif_addr, enum netconn_igmp join_or_leave);
donatien 0:422060928e37 242 #endif /* LWIP_IGMP */
donatien 0:422060928e37 243 #if LWIP_DNS
donatien 0:422060928e37 244 err_t netconn_gethostbyname(const char *name, ip_addr_t *addr);
donatien 0:422060928e37 245 #endif /* LWIP_DNS */
donatien 0:422060928e37 246
donatien 0:422060928e37 247 #define netconn_err(conn) ((conn)->last_err)
donatien 0:422060928e37 248 #define netconn_recv_bufsize(conn) ((conn)->recv_bufsize)
donatien 0:422060928e37 249
donatien 0:422060928e37 250 /** Set the blocking status of netconn calls (@todo: write/send is missing) */
donatien 0:422060928e37 251 #define netconn_set_nonblocking(conn, val) do { if(val) { \
donatien 0:422060928e37 252 (conn)->flags |= NETCONN_FLAG_NON_BLOCKING; \
donatien 0:422060928e37 253 } else { \
donatien 0:422060928e37 254 (conn)->flags &= ~ NETCONN_FLAG_NON_BLOCKING; }} while(0)
donatien 0:422060928e37 255 /** Get the blocking status of netconn calls (@todo: write/send is missing) */
donatien 0:422060928e37 256 #define netconn_is_nonblocking(conn) (((conn)->flags & NETCONN_FLAG_NON_BLOCKING) != 0)
donatien 0:422060928e37 257
donatien 0:422060928e37 258 /** TCP: Set the no-auto-recved status of netconn calls (see NETCONN_FLAG_NO_AUTO_RECVED) */
donatien 0:422060928e37 259 #define netconn_set_noautorecved(conn, val) do { if(val) { \
donatien 0:422060928e37 260 (conn)->flags |= NETCONN_FLAG_NO_AUTO_RECVED; \
donatien 0:422060928e37 261 } else { \
donatien 0:422060928e37 262 (conn)->flags &= ~ NETCONN_FLAG_NO_AUTO_RECVED; }} while(0)
donatien 0:422060928e37 263 /** TCP: Get the no-auto-recved status of netconn calls (see NETCONN_FLAG_NO_AUTO_RECVED) */
donatien 0:422060928e37 264 #define netconn_get_noautorecved(conn) (((conn)->flags & NETCONN_FLAG_NO_AUTO_RECVED) != 0)
donatien 0:422060928e37 265
donatien 0:422060928e37 266 #if LWIP_SO_RCVTIMEO
donatien 5:bc7df6da7589 267 /** Set the receive timeout in milliseconds */
donatien 0:422060928e37 268 #define netconn_set_recvtimeout(conn, timeout) ((conn)->recv_timeout = (timeout))
donatien 5:bc7df6da7589 269 /** Get the receive timeout in milliseconds */
donatien 0:422060928e37 270 #define netconn_get_recvtimeout(conn) ((conn)->recv_timeout)
donatien 0:422060928e37 271 #endif /* LWIP_SO_RCVTIMEO */
donatien 0:422060928e37 272 #if LWIP_SO_RCVBUF
donatien 0:422060928e37 273 /** Set the receive buffer in bytes */
donatien 0:422060928e37 274 #define netconn_set_recvbufsize(conn, recvbufsize) ((conn)->recv_bufsize = (recvbufsize))
donatien 0:422060928e37 275 /** Get the receive buffer in bytes */
donatien 0:422060928e37 276 #define netconn_get_recvbufsize(conn) ((conn)->recv_bufsize)
donatien 0:422060928e37 277 #endif /* LWIP_SO_RCVBUF*/
donatien 0:422060928e37 278
donatien 0:422060928e37 279 #ifdef __cplusplus
donatien 0:422060928e37 280 }
donatien 0:422060928e37 281 #endif
donatien 0:422060928e37 282
donatien 0:422060928e37 283 #endif /* LWIP_NETCONN */
donatien 0:422060928e37 284
donatien 0:422060928e37 285 #endif /* __LWIP_API_H__ */