1 /** 2 * @file 3 * Base TCP API definitions shared by TCP and ALTCP\n 4 * See also @ref tcp_raw 5 */ 6 7 /* 8 * Copyright (c) 2001-2004 Swedish Institute of Computer Science. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without modification, 12 * are permitted provided that the following conditions are met: 13 * 14 * 1. Redistributions of source code must retain the above copyright notice, 15 * this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright notice, 17 * this list of conditions and the following disclaimer in the documentation 18 * and/or other materials provided with the distribution. 19 * 3. The name of the author may not be used to endorse or promote products 20 * derived from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED 23 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 25 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 26 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 27 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 30 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY 31 * OF SUCH DAMAGE. 32 * 33 * This file is part of the lwIP TCP/IP stack. 34 * 35 * Author: Adam Dunkels <adam@sics.se> 36 * 37 */ 38 #ifndef LWIP_HDR_TCPBASE_H 39 #define LWIP_HDR_TCPBASE_H 40 41 #include "lwip/opt.h" 42 43 #if LWIP_TCP /* don't build if not configured for use in lwipopts.h */ 44 45 #ifdef __cplusplus 46 extern "C" { 47 #endif 48 49 50 #if LWIP_WND_SCALE 51 typedef u32_t tcpwnd_size_t; 52 #else 53 typedef u16_t tcpwnd_size_t; 54 #endif 55 56 /** Indicates the TCP state. */ 57 enum tcp_state { 58 CLOSED = 0, /**< Indicates that there is no connection. */ 59 /** 60 * Indicates that the local end-point waits for a connection 61 * request from a remote end-point. That is, a passive open was performed. 62 */ 63 LISTEN = 1, 64 SYN_SENT = 2, /**< SYN packet is sent. */ 65 SYN_RCVD = 3, /**< SYN packet is received. */ 66 /** 67 * The third step of the three-way connection handshake 68 * was performed. The connection is open. 69 */ 70 ESTABLISHED = 4, 71 /** 72 * The first step of an active close (four-way handshake) 73 * was performed. The local end-point has sent a connection termination request to the remote end-point. 74 */ 75 FIN_WAIT_1 = 5, 76 /** 77 * The remote end-point has sent an acknowledgement for the previouslysent connection termination request. 78 * The local end-point waits for an active connection termination request from the remote end-point. 79 */ 80 FIN_WAIT_2 = 6, 81 /** 82 * The local end-point has received a connection termination request 83 * and acknowledged it e.g. a passive close has been performed 84 * and the local end-point needs to perform an active close 85 * to leave this state. 86 */ 87 CLOSE_WAIT = 7, 88 /** 89 * The local end-point is waiting for an acknowledgement for a connection 90 * termination request before going to the TIME-WAIT state. 91 */ 92 CLOSING = 8, 93 /** 94 * The local end-point has performed a passive close and has 95 * initiated an active close by sending a connection termination request to the remote end-point. 96 */ 97 LAST_ACK = 9, 98 /** 99 * The local end-point waits for twice the maximum segment lifetime (MSL) 100 * to pass before going to CLOSED to be sure that the remote end-point received the acknowledgement. 101 */ 102 TIME_WAIT = 10 103 }; 104 105 /* Flags for "apiflags" parameter in tcp_write */ 106 #define TCP_WRITE_FLAG_COPY 0x01 107 #define TCP_WRITE_FLAG_MORE 0x02 108 109 #define TCP_PRIO_MIN 1 110 #define TCP_PRIO_NORMAL 64 111 #define TCP_PRIO_MAX 127 112 113 #ifdef __cplusplus 114 } 115 #endif 116 117 #endif /* LWIP_TCP */ 118 119 #endif /* LWIP_HDR_TCPBASE_H */ 120