Lorcan Smith / Mbed 2 deprecated Enet_SPI

SNMP agent attached to SPI slave

Dependencies:   mbed

lwip/include/lwip/tcp.h@0:2a53a4c3238c, 2012-08-13 (annotated)

Committer:
lorcansmith
Date:
Mon Aug 13 15:07:40 2012 +0000
Revision:
0:2a53a4c3238c
v1.1 release includes ioAlarm traps

Who changed what in which revision?

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