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/tcp.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_TCP_H__
GordonSin 0:0ed2a7c7190c 33 #define __LWIP_TCP_H__
GordonSin 0:0ed2a7c7190c 34
GordonSin 0:0ed2a7c7190c 35 #include "lwip/opt.h"
GordonSin 0:0ed2a7c7190c 36
GordonSin 0:0ed2a7c7190c 37 #if LWIP_TCP /* don't build if not configured for use in lwipopts.h */
GordonSin 0:0ed2a7c7190c 38
GordonSin 0:0ed2a7c7190c 39 #include "lwip/sys.h"
GordonSin 0:0ed2a7c7190c 40 #include "lwip/mem.h"
GordonSin 0:0ed2a7c7190c 41 #include "lwip/pbuf.h"
GordonSin 0:0ed2a7c7190c 42 #include "lwip/ip.h"
GordonSin 0:0ed2a7c7190c 43 #include "lwip/icmp.h"
GordonSin 0:0ed2a7c7190c 44 #include "lwip/err.h"
GordonSin 0:0ed2a7c7190c 45
GordonSin 0:0ed2a7c7190c 46 #ifdef __cplusplus
GordonSin 0:0ed2a7c7190c 47 extern "C" {
GordonSin 0:0ed2a7c7190c 48 #endif
GordonSin 0:0ed2a7c7190c 49
GordonSin 0:0ed2a7c7190c 50 struct tcp_pcb;
GordonSin 0:0ed2a7c7190c 51
GordonSin 0:0ed2a7c7190c 52 /** Function prototype for tcp accept callback functions. Called when a new
GordonSin 0:0ed2a7c7190c 53 * connection can be accepted on a listening pcb.
GordonSin 0:0ed2a7c7190c 54 *
GordonSin 0:0ed2a7c7190c 55 * @param arg Additional argument to pass to the callback function (@see tcp_arg())
GordonSin 0:0ed2a7c7190c 56 * @param newpcb The new connection pcb
GordonSin 0:0ed2a7c7190c 57 * @param err An error code if there has been an error accepting.
GordonSin 0:0ed2a7c7190c 58 * Only return ERR_ABRT if you have called tcp_abort from within the
GordonSin 0:0ed2a7c7190c 59 * callback function!
GordonSin 0:0ed2a7c7190c 60 */
GordonSin 0:0ed2a7c7190c 61 typedef err_t (*tcp_accept_fn)(void *arg, struct tcp_pcb *newpcb, err_t err);
GordonSin 0:0ed2a7c7190c 62
GordonSin 0:0ed2a7c7190c 63 /** Function prototype for tcp receive callback functions. Called when data has
GordonSin 0:0ed2a7c7190c 64 * been received.
GordonSin 0:0ed2a7c7190c 65 *
GordonSin 0:0ed2a7c7190c 66 * @param arg Additional argument to pass to the callback function (@see tcp_arg())
GordonSin 0:0ed2a7c7190c 67 * @param tpcb The connection pcb which received data
GordonSin 0:0ed2a7c7190c 68 * @param p The received data (or NULL when the connection has been closed!)
GordonSin 0:0ed2a7c7190c 69 * @param err An error code if there has been an error receiving
GordonSin 0:0ed2a7c7190c 70 * Only return ERR_ABRT if you have called tcp_abort from within the
GordonSin 0:0ed2a7c7190c 71 * callback function!
GordonSin 0:0ed2a7c7190c 72 */
GordonSin 0:0ed2a7c7190c 73 typedef err_t (*tcp_recv_fn)(void *arg, struct tcp_pcb *tpcb,
GordonSin 0:0ed2a7c7190c 74 struct pbuf *p, err_t err);
GordonSin 0:0ed2a7c7190c 75
GordonSin 0:0ed2a7c7190c 76 /** Function prototype for tcp sent callback functions. Called when sent data has
GordonSin 0:0ed2a7c7190c 77 * been acknowledged by the remote side. Use it to free corresponding resources.
GordonSin 0:0ed2a7c7190c 78 * This also means that the pcb has now space available to send new data.
GordonSin 0:0ed2a7c7190c 79 *
GordonSin 0:0ed2a7c7190c 80 * @param arg Additional argument to pass to the callback function (@see tcp_arg())
GordonSin 0:0ed2a7c7190c 81 * @param tpcb The connection pcb for which data has been acknowledged
GordonSin 0:0ed2a7c7190c 82 * @param len The amount of bytes acknowledged
GordonSin 0:0ed2a7c7190c 83 * @return ERR_OK: try to send some data by calling tcp_output
GordonSin 0:0ed2a7c7190c 84 * Only return ERR_ABRT if you have called tcp_abort from within the
GordonSin 0:0ed2a7c7190c 85 * callback function!
GordonSin 0:0ed2a7c7190c 86 */
GordonSin 0:0ed2a7c7190c 87 typedef err_t (*tcp_sent_fn)(void *arg, struct tcp_pcb *tpcb,
GordonSin 0:0ed2a7c7190c 88 u16_t len);
GordonSin 0:0ed2a7c7190c 89
GordonSin 0:0ed2a7c7190c 90 /** Function prototype for tcp poll callback functions. Called periodically as
GordonSin 0:0ed2a7c7190c 91 * specified by @see tcp_poll.
GordonSin 0:0ed2a7c7190c 92 *
GordonSin 0:0ed2a7c7190c 93 * @param arg Additional argument to pass to the callback function (@see tcp_arg())
GordonSin 0:0ed2a7c7190c 94 * @param tpcb tcp pcb
GordonSin 0:0ed2a7c7190c 95 * @return ERR_OK: try to send some data by calling tcp_output
GordonSin 0:0ed2a7c7190c 96 * Only return ERR_ABRT if you have called tcp_abort from within the
GordonSin 0:0ed2a7c7190c 97 * callback function!
GordonSin 0:0ed2a7c7190c 98 */
GordonSin 0:0ed2a7c7190c 99 typedef err_t (*tcp_poll_fn)(void *arg, struct tcp_pcb *tpcb);
GordonSin 0:0ed2a7c7190c 100
GordonSin 0:0ed2a7c7190c 101 /** Function prototype for tcp error callback functions. Called when the pcb
GordonSin 0:0ed2a7c7190c 102 * receives a RST or is unexpectedly closed for any other reason.
GordonSin 0:0ed2a7c7190c 103 *
GordonSin 0:0ed2a7c7190c 104 * @note The corresponding pcb is already freed when this callback is called!
GordonSin 0:0ed2a7c7190c 105 *
GordonSin 0:0ed2a7c7190c 106 * @param arg Additional argument to pass to the callback function (@see tcp_arg())
GordonSin 0:0ed2a7c7190c 107 * @param err Error code to indicate why the pcb has been closed
GordonSin 0:0ed2a7c7190c 108 * ERR_ABRT: aborted through tcp_abort or by a TCP timer
GordonSin 0:0ed2a7c7190c 109 * ERR_RST: the connection was reset by the remote host
GordonSin 0:0ed2a7c7190c 110 */
GordonSin 0:0ed2a7c7190c 111 typedef void (*tcp_err_fn)(void *arg, err_t err);
GordonSin 0:0ed2a7c7190c 112
GordonSin 0:0ed2a7c7190c 113 /** Function prototype for tcp connected callback functions. Called when a pcb
GordonSin 0:0ed2a7c7190c 114 * is connected to the remote side after initiating a connection attempt by
GordonSin 0:0ed2a7c7190c 115 * calling tcp_connect().
GordonSin 0:0ed2a7c7190c 116 *
GordonSin 0:0ed2a7c7190c 117 * @param arg Additional argument to pass to the callback function (@see tcp_arg())
GordonSin 0:0ed2a7c7190c 118 * @param tpcb The connection pcb which is connected
GordonSin 0:0ed2a7c7190c 119 * @param err An unused error code, always ERR_OK currently ;-) TODO!
GordonSin 0:0ed2a7c7190c 120 * Only return ERR_ABRT if you have called tcp_abort from within the
GordonSin 0:0ed2a7c7190c 121 * callback function!
GordonSin 0:0ed2a7c7190c 122 *
GordonSin 0:0ed2a7c7190c 123 * @note When a connection attempt fails, the error callback is currently called!
GordonSin 0:0ed2a7c7190c 124 */
GordonSin 0:0ed2a7c7190c 125 typedef err_t (*tcp_connected_fn)(void *arg, struct tcp_pcb *tpcb, err_t err);
GordonSin 0:0ed2a7c7190c 126
GordonSin 0:0ed2a7c7190c 127 enum tcp_state {
GordonSin 0:0ed2a7c7190c 128 CLOSED = 0,
GordonSin 0:0ed2a7c7190c 129 LISTEN = 1,
GordonSin 0:0ed2a7c7190c 130 SYN_SENT = 2,
GordonSin 0:0ed2a7c7190c 131 SYN_RCVD = 3,
GordonSin 0:0ed2a7c7190c 132 ESTABLISHED = 4,
GordonSin 0:0ed2a7c7190c 133 FIN_WAIT_1 = 5,
GordonSin 0:0ed2a7c7190c 134 FIN_WAIT_2 = 6,
GordonSin 0:0ed2a7c7190c 135 CLOSE_WAIT = 7,
GordonSin 0:0ed2a7c7190c 136 CLOSING = 8,
GordonSin 0:0ed2a7c7190c 137 LAST_ACK = 9,
GordonSin 0:0ed2a7c7190c 138 TIME_WAIT = 10
GordonSin 0:0ed2a7c7190c 139 };
GordonSin 0:0ed2a7c7190c 140
GordonSin 0:0ed2a7c7190c 141 #if LWIP_CALLBACK_API
GordonSin 0:0ed2a7c7190c 142 /* Function to call when a listener has been connected.
GordonSin 0:0ed2a7c7190c 143 * @param arg user-supplied argument (tcp_pcb.callback_arg)
GordonSin 0:0ed2a7c7190c 144 * @param pcb a new tcp_pcb that now is connected
GordonSin 0:0ed2a7c7190c 145 * @param err an error argument (TODO: that is current always ERR_OK?)
GordonSin 0:0ed2a7c7190c 146 * @return ERR_OK: accept the new connection,
GordonSin 0:0ed2a7c7190c 147 * any other err_t abortsthe new connection
GordonSin 0:0ed2a7c7190c 148 */
GordonSin 0:0ed2a7c7190c 149 #define DEF_ACCEPT_CALLBACK tcp_accept_fn accept;
GordonSin 0:0ed2a7c7190c 150 #else /* LWIP_CALLBACK_API */
GordonSin 0:0ed2a7c7190c 151 #define DEF_ACCEPT_CALLBACK
GordonSin 0:0ed2a7c7190c 152 #endif /* LWIP_CALLBACK_API */
GordonSin 0:0ed2a7c7190c 153
GordonSin 0:0ed2a7c7190c 154 /**
GordonSin 0:0ed2a7c7190c 155 * members common to struct tcp_pcb and struct tcp_listen_pcb
GordonSin 0:0ed2a7c7190c 156 */
GordonSin 0:0ed2a7c7190c 157 #define TCP_PCB_COMMON(type) \
GordonSin 0:0ed2a7c7190c 158 type *next; /* for the linked list */ \
GordonSin 0:0ed2a7c7190c 159 enum tcp_state state; /* TCP state */ \
GordonSin 0:0ed2a7c7190c 160 u8_t prio; \
GordonSin 0:0ed2a7c7190c 161 void *callback_arg; \
GordonSin 0:0ed2a7c7190c 162 /* the accept callback for listen- and normal pcbs, if LWIP_CALLBACK_API */ \
GordonSin 0:0ed2a7c7190c 163 DEF_ACCEPT_CALLBACK \
GordonSin 0:0ed2a7c7190c 164 /* ports are in host byte order */ \
GordonSin 0:0ed2a7c7190c 165 u16_t local_port
GordonSin 0:0ed2a7c7190c 166
GordonSin 0:0ed2a7c7190c 167
GordonSin 0:0ed2a7c7190c 168 /* the TCP protocol control block */
GordonSin 0:0ed2a7c7190c 169 struct tcp_pcb {
GordonSin 0:0ed2a7c7190c 170 /** common PCB members */
GordonSin 0:0ed2a7c7190c 171 IP_PCB;
GordonSin 0:0ed2a7c7190c 172 /** protocol specific PCB members */
GordonSin 0:0ed2a7c7190c 173 TCP_PCB_COMMON(struct tcp_pcb);
GordonSin 0:0ed2a7c7190c 174
GordonSin 0:0ed2a7c7190c 175 /* ports are in host byte order */
GordonSin 0:0ed2a7c7190c 176 u16_t remote_port;
GordonSin 0:0ed2a7c7190c 177
GordonSin 0:0ed2a7c7190c 178 u8_t flags;
GordonSin 0:0ed2a7c7190c 179 #define TF_ACK_DELAY ((u8_t)0x01U) /* Delayed ACK. */
GordonSin 0:0ed2a7c7190c 180 #define TF_ACK_NOW ((u8_t)0x02U) /* Immediate ACK. */
GordonSin 0:0ed2a7c7190c 181 #define TF_INFR ((u8_t)0x04U) /* In fast recovery. */
GordonSin 0:0ed2a7c7190c 182 #define TF_TIMESTAMP ((u8_t)0x08U) /* Timestamp option enabled */
GordonSin 0:0ed2a7c7190c 183 #define TF_RXCLOSED ((u8_t)0x10U) /* rx closed by tcp_shutdown */
GordonSin 0:0ed2a7c7190c 184 #define TF_FIN ((u8_t)0x20U) /* Connection was closed locally (FIN segment enqueued). */
GordonSin 0:0ed2a7c7190c 185 #define TF_NODELAY ((u8_t)0x40U) /* Disable Nagle algorithm */
GordonSin 0:0ed2a7c7190c 186 #define TF_NAGLEMEMERR ((u8_t)0x80U) /* nagle enabled, memerr, try to output to prevent delayed ACK to happen */
GordonSin 0:0ed2a7c7190c 187
GordonSin 0:0ed2a7c7190c 188 /* the rest of the fields are in host byte order
GordonSin 0:0ed2a7c7190c 189 as we have to do some math with them */
GordonSin 0:0ed2a7c7190c 190 /* receiver variables */
GordonSin 0:0ed2a7c7190c 191 u32_t rcv_nxt; /* next seqno expected */
GordonSin 0:0ed2a7c7190c 192 u16_t rcv_wnd; /* receiver window available */
GordonSin 0:0ed2a7c7190c 193 u16_t rcv_ann_wnd; /* receiver window to announce */
GordonSin 0:0ed2a7c7190c 194 u32_t rcv_ann_right_edge; /* announced right edge of window */
GordonSin 0:0ed2a7c7190c 195
GordonSin 0:0ed2a7c7190c 196 /* Timers */
GordonSin 0:0ed2a7c7190c 197 u32_t tmr;
GordonSin 0:0ed2a7c7190c 198 u8_t polltmr, pollinterval;
GordonSin 0:0ed2a7c7190c 199
GordonSin 0:0ed2a7c7190c 200 /* Retransmission timer. */
GordonSin 0:0ed2a7c7190c 201 s16_t rtime;
GordonSin 0:0ed2a7c7190c 202
GordonSin 0:0ed2a7c7190c 203 u16_t mss; /* maximum segment size */
GordonSin 0:0ed2a7c7190c 204
GordonSin 0:0ed2a7c7190c 205 /* RTT (round trip time) estimation variables */
GordonSin 0:0ed2a7c7190c 206 u32_t rttest; /* RTT estimate in 500ms ticks */
GordonSin 0:0ed2a7c7190c 207 u32_t rtseq; /* sequence number being timed */
GordonSin 0:0ed2a7c7190c 208 s16_t sa, sv; /* @todo document this */
GordonSin 0:0ed2a7c7190c 209
GordonSin 0:0ed2a7c7190c 210 s16_t rto; /* retransmission time-out */
GordonSin 0:0ed2a7c7190c 211 u8_t nrtx; /* number of retransmissions */
GordonSin 0:0ed2a7c7190c 212
GordonSin 0:0ed2a7c7190c 213 /* fast retransmit/recovery */
GordonSin 0:0ed2a7c7190c 214 u32_t lastack; /* Highest acknowledged seqno. */
GordonSin 0:0ed2a7c7190c 215 u8_t dupacks;
GordonSin 0:0ed2a7c7190c 216
GordonSin 0:0ed2a7c7190c 217 /* congestion avoidance/control variables */
GordonSin 0:0ed2a7c7190c 218 u16_t cwnd;
GordonSin 0:0ed2a7c7190c 219 u16_t ssthresh;
GordonSin 0:0ed2a7c7190c 220
GordonSin 0:0ed2a7c7190c 221 /* sender variables */
GordonSin 0:0ed2a7c7190c 222 u32_t snd_nxt; /* next new seqno to be sent */
GordonSin 0:0ed2a7c7190c 223 u16_t snd_wnd; /* sender window */
GordonSin 0:0ed2a7c7190c 224 u32_t snd_wl1, snd_wl2; /* Sequence and acknowledgement numbers of last
GordonSin 0:0ed2a7c7190c 225 window update. */
GordonSin 0:0ed2a7c7190c 226 u32_t snd_lbb; /* Sequence number of next byte to be buffered. */
GordonSin 0:0ed2a7c7190c 227
GordonSin 0:0ed2a7c7190c 228 u16_t acked;
GordonSin 0:0ed2a7c7190c 229
GordonSin 0:0ed2a7c7190c 230 u16_t snd_buf; /* Available buffer space for sending (in bytes). */
GordonSin 0:0ed2a7c7190c 231 #define TCP_SNDQUEUELEN_OVERFLOW (0xffffU-3)
GordonSin 0:0ed2a7c7190c 232 u16_t snd_queuelen; /* Available buffer space for sending (in tcp_segs). */
GordonSin 0:0ed2a7c7190c 233
GordonSin 0:0ed2a7c7190c 234 #if TCP_OVERSIZE
GordonSin 0:0ed2a7c7190c 235 /* Extra bytes available at the end of the last pbuf in unsent. */
GordonSin 0:0ed2a7c7190c 236 u16_t unsent_oversize;
GordonSin 0:0ed2a7c7190c 237 #endif /* TCP_OVERSIZE */
GordonSin 0:0ed2a7c7190c 238
GordonSin 0:0ed2a7c7190c 239 /* These are ordered by sequence number: */
GordonSin 0:0ed2a7c7190c 240 struct tcp_seg *unsent; /* Unsent (queued) segments. */
GordonSin 0:0ed2a7c7190c 241 struct tcp_seg *unacked; /* Sent but unacknowledged segments. */
GordonSin 0:0ed2a7c7190c 242 #if TCP_QUEUE_OOSEQ
GordonSin 0:0ed2a7c7190c 243 struct tcp_seg *ooseq; /* Received out of sequence segments. */
GordonSin 0:0ed2a7c7190c 244 #endif /* TCP_QUEUE_OOSEQ */
GordonSin 0:0ed2a7c7190c 245
GordonSin 0:0ed2a7c7190c 246 struct pbuf *refused_data; /* Data previously received but not yet taken by upper layer */
GordonSin 0:0ed2a7c7190c 247
GordonSin 0:0ed2a7c7190c 248 #if LWIP_CALLBACK_API
GordonSin 0:0ed2a7c7190c 249 /* Function to be called when more send buffer space is available. */
GordonSin 0:0ed2a7c7190c 250 tcp_sent_fn sent;
GordonSin 0:0ed2a7c7190c 251 /* Function to be called when (in-sequence) data has arrived. */
GordonSin 0:0ed2a7c7190c 252 tcp_recv_fn recv;
GordonSin 0:0ed2a7c7190c 253 /* Function to be called when a connection has been set up. */
GordonSin 0:0ed2a7c7190c 254 tcp_connected_fn connected;
GordonSin 0:0ed2a7c7190c 255 /* Function which is called periodically. */
GordonSin 0:0ed2a7c7190c 256 tcp_poll_fn poll;
GordonSin 0:0ed2a7c7190c 257 /* Function to be called whenever a fatal error occurs. */
GordonSin 0:0ed2a7c7190c 258 tcp_err_fn errf;
GordonSin 0:0ed2a7c7190c 259 #endif /* LWIP_CALLBACK_API */
GordonSin 0:0ed2a7c7190c 260
GordonSin 0:0ed2a7c7190c 261 #if LWIP_TCP_TIMESTAMPS
GordonSin 0:0ed2a7c7190c 262 u32_t ts_lastacksent;
GordonSin 0:0ed2a7c7190c 263 u32_t ts_recent;
GordonSin 0:0ed2a7c7190c 264 #endif /* LWIP_TCP_TIMESTAMPS */
GordonSin 0:0ed2a7c7190c 265
GordonSin 0:0ed2a7c7190c 266 /* idle time before KEEPALIVE is sent */
GordonSin 0:0ed2a7c7190c 267 u32_t keep_idle;
GordonSin 0:0ed2a7c7190c 268 #if LWIP_TCP_KEEPALIVE
GordonSin 0:0ed2a7c7190c 269 u32_t keep_intvl;
GordonSin 0:0ed2a7c7190c 270 u32_t keep_cnt;
GordonSin 0:0ed2a7c7190c 271 #endif /* LWIP_TCP_KEEPALIVE */
GordonSin 0:0ed2a7c7190c 272
GordonSin 0:0ed2a7c7190c 273 /* Persist timer counter */
GordonSin 0:0ed2a7c7190c 274 u32_t persist_cnt;
GordonSin 0:0ed2a7c7190c 275 /* Persist timer back-off */
GordonSin 0:0ed2a7c7190c 276 u8_t persist_backoff;
GordonSin 0:0ed2a7c7190c 277
GordonSin 0:0ed2a7c7190c 278 /* KEEPALIVE counter */
GordonSin 0:0ed2a7c7190c 279 u8_t keep_cnt_sent;
GordonSin 0:0ed2a7c7190c 280 };
GordonSin 0:0ed2a7c7190c 281
GordonSin 0:0ed2a7c7190c 282 struct tcp_pcb_listen {
GordonSin 0:0ed2a7c7190c 283 /* Common members of all PCB types */
GordonSin 0:0ed2a7c7190c 284 IP_PCB;
GordonSin 0:0ed2a7c7190c 285 /* Protocol specific PCB members */
GordonSin 0:0ed2a7c7190c 286 TCP_PCB_COMMON(struct tcp_pcb_listen);
GordonSin 0:0ed2a7c7190c 287
GordonSin 0:0ed2a7c7190c 288 #if TCP_LISTEN_BACKLOG
GordonSin 0:0ed2a7c7190c 289 u8_t backlog;
GordonSin 0:0ed2a7c7190c 290 u8_t accepts_pending;
GordonSin 0:0ed2a7c7190c 291 #endif /* TCP_LISTEN_BACKLOG */
GordonSin 0:0ed2a7c7190c 292 };
GordonSin 0:0ed2a7c7190c 293
GordonSin 0:0ed2a7c7190c 294 #if LWIP_EVENT_API
GordonSin 0:0ed2a7c7190c 295
GordonSin 0:0ed2a7c7190c 296 enum lwip_event {
GordonSin 0:0ed2a7c7190c 297 LWIP_EVENT_ACCEPT,
GordonSin 0:0ed2a7c7190c 298 LWIP_EVENT_SENT,
GordonSin 0:0ed2a7c7190c 299 LWIP_EVENT_RECV,
GordonSin 0:0ed2a7c7190c 300 LWIP_EVENT_CONNECTED,
GordonSin 0:0ed2a7c7190c 301 LWIP_EVENT_POLL,
GordonSin 0:0ed2a7c7190c 302 LWIP_EVENT_ERR
GordonSin 0:0ed2a7c7190c 303 };
GordonSin 0:0ed2a7c7190c 304
GordonSin 0:0ed2a7c7190c 305 err_t lwip_tcp_event(void *arg, struct tcp_pcb *pcb,
GordonSin 0:0ed2a7c7190c 306 enum lwip_event,
GordonSin 0:0ed2a7c7190c 307 struct pbuf *p,
GordonSin 0:0ed2a7c7190c 308 u16_t size,
GordonSin 0:0ed2a7c7190c 309 err_t err);
GordonSin 0:0ed2a7c7190c 310
GordonSin 0:0ed2a7c7190c 311 #endif /* LWIP_EVENT_API */
GordonSin 0:0ed2a7c7190c 312
GordonSin 0:0ed2a7c7190c 313 /* Application program's interface: */
GordonSin 0:0ed2a7c7190c 314 struct tcp_pcb * tcp_new (void);
GordonSin 0:0ed2a7c7190c 315
GordonSin 0:0ed2a7c7190c 316 void tcp_arg (struct tcp_pcb *pcb, void *arg);
GordonSin 0:0ed2a7c7190c 317 void tcp_accept (struct tcp_pcb *pcb, tcp_accept_fn accept);
GordonSin 0:0ed2a7c7190c 318 void tcp_recv (struct tcp_pcb *pcb, tcp_recv_fn recv);
GordonSin 0:0ed2a7c7190c 319 void tcp_sent (struct tcp_pcb *pcb, tcp_sent_fn sent);
GordonSin 0:0ed2a7c7190c 320 void tcp_poll (struct tcp_pcb *pcb, tcp_poll_fn poll, u8_t interval);
GordonSin 0:0ed2a7c7190c 321 void tcp_err (struct tcp_pcb *pcb, tcp_err_fn err);
GordonSin 0:0ed2a7c7190c 322
GordonSin 0:0ed2a7c7190c 323 #define tcp_mss(pcb) (((pcb)->flags & TF_TIMESTAMP) ? ((pcb)->mss - 12) : (pcb)->mss)
GordonSin 0:0ed2a7c7190c 324 #define tcp_sndbuf(pcb) ((pcb)->snd_buf)
GordonSin 0:0ed2a7c7190c 325 #define tcp_sndqueuelen(pcb) ((pcb)->snd_queuelen)
GordonSin 0:0ed2a7c7190c 326 #define tcp_nagle_disable(pcb) ((pcb)->flags |= TF_NODELAY)
GordonSin 0:0ed2a7c7190c 327 #define tcp_nagle_enable(pcb) ((pcb)->flags &= ~TF_NODELAY)
GordonSin 0:0ed2a7c7190c 328 #define tcp_nagle_disabled(pcb) (((pcb)->flags & TF_NODELAY) != 0)
GordonSin 0:0ed2a7c7190c 329
GordonSin 0:0ed2a7c7190c 330 #if TCP_LISTEN_BACKLOG
GordonSin 0:0ed2a7c7190c 331 #define tcp_accepted(pcb) do { \
GordonSin 0:0ed2a7c7190c 332 LWIP_ASSERT("pcb->state == LISTEN (called for wrong pcb?)", pcb->state == LISTEN); \
GordonSin 0:0ed2a7c7190c 333 (((struct tcp_pcb_listen *)(pcb))->accepts_pending--); } while(0)
GordonSin 0:0ed2a7c7190c 334 #else /* TCP_LISTEN_BACKLOG */
GordonSin 0:0ed2a7c7190c 335 #define tcp_accepted(pcb) LWIP_ASSERT("pcb->state == LISTEN (called for wrong pcb?)", \
GordonSin 0:0ed2a7c7190c 336 pcb->state == LISTEN)
GordonSin 0:0ed2a7c7190c 337 #endif /* TCP_LISTEN_BACKLOG */
GordonSin 0:0ed2a7c7190c 338
GordonSin 0:0ed2a7c7190c 339 void tcp_recved (struct tcp_pcb *pcb, u16_t len);
GordonSin 0:0ed2a7c7190c 340 err_t tcp_bind (struct tcp_pcb *pcb, ip_addr_t *ipaddr,
GordonSin 0:0ed2a7c7190c 341 u16_t port);
GordonSin 0:0ed2a7c7190c 342 err_t tcp_connect (struct tcp_pcb *pcb, ip_addr_t *ipaddr,
GordonSin 0:0ed2a7c7190c 343 u16_t port, tcp_connected_fn connected);
GordonSin 0:0ed2a7c7190c 344
GordonSin 0:0ed2a7c7190c 345 struct tcp_pcb * tcp_listen_with_backlog(struct tcp_pcb *pcb, u8_t backlog);
GordonSin 0:0ed2a7c7190c 346 #define tcp_listen(pcb) tcp_listen_with_backlog(pcb, TCP_DEFAULT_LISTEN_BACKLOG)
GordonSin 0:0ed2a7c7190c 347
GordonSin 0:0ed2a7c7190c 348 void tcp_abort (struct tcp_pcb *pcb);
GordonSin 0:0ed2a7c7190c 349 err_t tcp_close (struct tcp_pcb *pcb);
GordonSin 0:0ed2a7c7190c 350 err_t tcp_shutdown(struct tcp_pcb *pcb, int shut_rx, int shut_tx);
GordonSin 0:0ed2a7c7190c 351
GordonSin 0:0ed2a7c7190c 352 /* Flags for "apiflags" parameter in tcp_write */
GordonSin 0:0ed2a7c7190c 353 #define TCP_WRITE_FLAG_COPY 0x01
GordonSin 0:0ed2a7c7190c 354 #define TCP_WRITE_FLAG_MORE 0x02
GordonSin 0:0ed2a7c7190c 355
GordonSin 0:0ed2a7c7190c 356 err_t tcp_write (struct tcp_pcb *pcb, const void *dataptr, u16_t len,
GordonSin 0:0ed2a7c7190c 357 u8_t apiflags);
GordonSin 0:0ed2a7c7190c 358
GordonSin 0:0ed2a7c7190c 359 void tcp_setprio (struct tcp_pcb *pcb, u8_t prio);
GordonSin 0:0ed2a7c7190c 360
GordonSin 0:0ed2a7c7190c 361 #define TCP_PRIO_MIN 1
GordonSin 0:0ed2a7c7190c 362 #define TCP_PRIO_NORMAL 64
GordonSin 0:0ed2a7c7190c 363 #define TCP_PRIO_MAX 127
GordonSin 0:0ed2a7c7190c 364
GordonSin 0:0ed2a7c7190c 365 err_t tcp_output (struct tcp_pcb *pcb);
GordonSin 0:0ed2a7c7190c 366
GordonSin 0:0ed2a7c7190c 367
GordonSin 0:0ed2a7c7190c 368 const char* tcp_debug_state_str(enum tcp_state s);
GordonSin 0:0ed2a7c7190c 369
GordonSin 0:0ed2a7c7190c 370
GordonSin 0:0ed2a7c7190c 371 #ifdef __cplusplus
GordonSin 0:0ed2a7c7190c 372 }
GordonSin 0:0ed2a7c7190c 373 #endif
GordonSin 0:0ed2a7c7190c 374
GordonSin 0:0ed2a7c7190c 375 #endif /* LWIP_TCP */
GordonSin 0:0ed2a7c7190c 376
GordonSin 0:0ed2a7c7190c 377 #endif /* __LWIP_TCP_H__ */