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