tcp.h File Reference
TCP (Transmission Control Protocol) More...
Go to the source code of this file.
Data Structures | |
| struct | _TcpQueueItem |
| Retransmission queue item. More... | |
| struct | _TcpSynQueueItem |
| SYN queue item. More... | |
| struct | TcpSackBlock |
| SACK block. More... | |
| struct | TcpTxBuffer |
| Transmit buffer. More... | |
| struct | TcpRxBuffer |
| Receive buffer. More... | |
Typedefs | |
| struct { | |
| char_t type | |
| uint32_t dataStart | |
| uint32_t dataLength | |
| uint8_t nameLength | |
| char_t name [] | |
| uint8_t tokenLen: 4 | |
| uint8_t type: 2 | |
| uint8_t version: 2 | |
| uint8_t code | |
| uint16_t mid | |
| uint8_t token [] | |
| union { | |
| uint8_t b [6] | |
| uint16_t w [3] | |
| } | |
| uint16_t srcPort | |
| uint16_t destPort | |
| uint32_t seqNum | |
| uint32_t ackNum | |
| uint8_t reserved1: 4 | |
| uint8_t dataOffset: 4 | |
| uint8_t flags: 6 | |
| uint8_t reserved2: 2 | |
| uint16_t window | |
| uint16_t checksum | |
| uint16_t urgentPointer | |
| uint8_t options [] | |
| uint16_t length | |
| uint8_t data [] | |
| uint8_t op | |
| uint8_t htype | |
| uint8_t hlen | |
| uint8_t hops | |
| uint32_t xid | |
| uint16_t secs | |
| uint16_t flags | |
| Ipv4Addr ciaddr | |
| Ipv4Addr yiaddr | |
| Ipv4Addr siaddr | |
| Ipv4Addr giaddr | |
| MacAddr chaddr | |
| uint8_t unused [10] | |
| uint8_t sname [64] | |
| uint8_t file [128] | |
| uint32_t magicCookie | |
| uint16_t type | |
| uint16_t hardwareType | |
| uint32_t time | |
| MacAddr linkLayerAddr | |
| uint16_t id | |
| uint8_t rd: 1 | |
| uint8_t tc: 1 | |
| uint8_t aa: 1 | |
| uint8_t opcode: 4 | |
| uint8_t qr: 1 | |
| uint8_t rcode: 4 | |
| uint8_t z: 3 | |
| uint8_t ra: 1 | |
| uint16_t qdcount | |
| uint16_t ancount | |
| uint16_t nscount | |
| uint16_t arcount | |
| uint8_t questions [] | |
| uint16_t controlWord | |
| uint16_t byteCount | |
| uint8_t bLength | |
| uint8_t bDescriptorType | |
| uint16_t bcdUsb | |
| uint8_t bDeviceClass | |
| uint8_t bDeviceSubClass | |
| uint8_t bDeviceProtocol | |
| uint8_t bMaxPacketSize0 | |
| uint16_t idVendor | |
| uint16_t idProduct | |
| uint16_t bcdDevice | |
| uint8_t iManufacturer | |
| uint8_t iProduct | |
| uint8_t iSerialNumber | |
| uint8_t bNumConfigurations | |
| uint8_t maxRespTime | |
| Ipv4Addr groupAddr | |
| uint16_t hrd | |
| uint16_t pro | |
| uint8_t hln | |
| uint8_t pln | |
| uint16_t op | |
| MacAddr sha | |
| Ipv4Addr spa | |
| MacAddr tha | |
| Ipv4Addr tpa | |
| uint8_t length | |
| uint8_t value [] | |
| uint16_t first | |
| uint16_t last | |
| uint16_t next | |
| union { | |
| uint8_t b [16] | |
| uint16_t w [8] | |
| uint32_t dw [4] | |
| } | |
| uint16_t maxRespDelay | |
| uint16_t reserved | |
| Ipv6Addr multicastAddr | |
| uint32_t reserved | |
| uint16_t pvid | |
| uint8_t autoNegSupportStatus | |
| uint16_t pmdAutoNegAdvCap | |
| uint16_t operationalMauType | |
| uint16_t capabilities | |
| uint8_t deviceType | |
| uint8_t lengthH: 1 | |
| uint8_t lengthL | |
| uint8_t t: 1 | |
| uint8_t c: 1 | |
| union { | |
| int32_t integer | |
| uint8_t octetString [1] | |
| uint8_t oid [1] | |
| uint8_t ipAddr [4] | |
| uint32_t counter32 | |
| uint32_t gauge32 | |
| uint32_t unsigned32 | |
| uint32_t timeTicks | |
| uint64_t counter64 | |
| } | |
| uint16_t transactionId | |
| uint16_t protocolId | |
| uint8_t unitId | |
| uint8_t pdu [] | |
| uint8_t retain: 1 | |
| uint8_t qos: 2 | |
| uint8_t dup: 1 | |
| union { | |
| uint8_t all | |
| struct { | |
| uint8_t topicIdType: 2 | |
| uint8_t cleanSession: 1 | |
| uint8_t will: 1 | |
| uint8_t retain: 1 | |
| uint8_t qos: 2 | |
| uint8_t dup: 1 | |
| } | |
| } | |
| uint8_t b: 1 | |
| uint8_t identifier | |
| uint8_t valueSize | |
| Ipv4Addr srcIpAddr | |
| Ipv4Addr destIpAddr | |
| Eui64 interfaceId | |
| uint16_t mru | |
| uint8_t peerIdLength | |
| uint8_t peerId [] | |
| uint32_t seconds | |
| uint32_t fraction | |
| uint16_t opcode | |
| char_t filename [] | |
| uint8_t reserved: 3 | |
| uint8_t fin: 1 | |
| uint8_t payloadLen: 7 | |
| uint8_t mask: 1 | |
| uint8_t extPayloadLen [] | |
| uint32_t length | |
| uint8_t payload [] | |
| uint8_t protocolVersionId | |
| uint8_t bpduType | |
| StpBridgeId rootId | |
| uint32_t rootPathCost | |
| StpBridgeId bridgeId | |
| uint16_t portId | |
| uint16_t messageAge | |
| uint16_t maxAge | |
| uint16_t helloTime | |
| uint16_t forwardDelay | |
| uint8_t version1Length | |
| uint16_t priority | |
| MacAddr addr | |
| } | TcpHeader |
| TCP header. More... | |
| struct { | |
| char_t type | |
| uint32_t dataStart | |
| uint32_t dataLength | |
| uint8_t nameLength | |
| uint8_t length: 4 | |
| uint8_t delta: 4 | |
| union { | |
| uint8_t b [8] | |
| uint16_t w [4] | |
| uint32_t dw [2] | |
| } | |
| uint8_t kind | |
| uint8_t value [] | |
| uint8_t code | |
| uint16_t type | |
| uint32_t enterpriseNumber | |
| uint8_t identifier [] | |
| uint16_t qtype | |
| uint16_t qclass | |
| uint16_t statusWord | |
| uint16_t byteCount | |
| uint8_t bLength | |
| uint8_t bDescriptorType | |
| uint16_t wTotalLength | |
| uint8_t bNumInterfaces | |
| uint8_t bConfigurationValue | |
| uint8_t iConfiguration | |
| uint8_t bmAttributes | |
| uint8_t bMaxPower | |
| uint8_t type | |
| uint16_t checksum | |
| uint8_t parameter | |
| uint8_t unused [3] | |
| uint8_t data [] | |
| uint32_t parameter | |
| uint8_t nextHeader | |
| uint8_t hdrExtLen | |
| uint8_t options [] | |
| uint8_t curHopLimit | |
| uint8_t reserved: 2 | |
| uint8_t p: 1 | |
| uint8_t prf: 2 | |
| uint8_t h: 1 | |
| uint8_t o: 1 | |
| uint8_t m: 1 | |
| uint16_t routerLifetime | |
| uint32_t reachableTime | |
| uint32_t retransTimer | |
| uint8_t flags | |
| uint16_t ppvid | |
| uint8_t mdiPowerSupport | |
| uint8_t psePowerPair | |
| uint8_t powerClass | |
| uint8_t appType | |
| uint8_t vlanIdH: 5 | |
| uint8_t x: 1 | |
| uint8_t t: 1 | |
| uint8_t u: 1 | |
| uint8_t l2PriorityH: 1 | |
| uint8_t vlanIdL: 7 | |
| uint8_t dscpValue: 6 | |
| uint8_t l2PriorityL: 2 | |
| uint8_t chassisIdSubtype | |
| uint8_t chassisId [] | |
| uint8_t functionCode | |
| uint16_t startingAddr | |
| uint16_t quantityOfCoils | |
| uint16_t length | |
| uint8_t msgType | |
| uint16_t flags | |
| Ipv4Addr addr | |
| uint8_t valueSize | |
| uint16_t protocol | |
| uint32_t accm | |
| uint8_t msgLength | |
| uint8_t message [] | |
| uint8_t mode: 3 | |
| uint8_t vn: 3 | |
| uint8_t li: 2 | |
| uint8_t stratum | |
| uint8_t poll | |
| int8_t precision | |
| uint32_t rootDelay | |
| uint32_t rootDispersion | |
| uint32_t referenceId | |
| NtpTimestamp referenceTimestamp | |
| NtpTimestamp originateTimestamp | |
| NtpTimestamp receiveTimestamp | |
| NtpTimestamp transmitTimestamp | |
| uint16_t opcode | |
| char_t filename [] | |
| uint16_t value [] | |
| uint16_t group | |
| uint8_t keyExchange [] | |
| uint32_t id | |
| uint32_t dataLen | |
| } | TcpOption |
| TCP option. More... | |
| typedef struct _TcpQueueItem | TcpQueueItem |
| Retransmission queue item. More... | |
| typedef struct _TcpSynQueueItem | TcpSynQueueItem |
| SYN queue item. More... | |
Enumerations | |
| enum | TcpState { TCP_STATE_CLOSED = 0, TCP_STATE_LISTEN = 1, TCP_STATE_SYN_SENT = 2, TCP_STATE_SYN_RECEIVED = 3, TCP_STATE_ESTABLISHED = 4, TCP_STATE_CLOSE_WAIT = 5, TCP_STATE_LAST_ACK = 6, TCP_STATE_FIN_WAIT_1 = 7, TCP_STATE_FIN_WAIT_2 = 8, TCP_STATE_CLOSING = 9, TCP_STATE_TIME_WAIT = 10 } |
| TCP FSM states. More... | |
| enum | TcpCongestState { TCP_CONGEST_STATE_IDLE = 0, TCP_CONGEST_STATE_RECOVERY = 1, TCP_CONGEST_STATE_LOSS_RECOVERY = 2 } |
| TCP congestion states. More... | |
| enum | TcpFlags { TCP_FLAG_FIN = 0x01, TCP_FLAG_SYN = 0x02, TCP_FLAG_RST = 0x04, TCP_FLAG_PSH = 0x08, TCP_FLAG_ACK = 0x10, TCP_FLAG_URG = 0x20 } |
| TCP control flags. More... | |
| enum | TcpOptionKind { TCP_OPTION_END = 0, TCP_OPTION_NOP = 1, TCP_OPTION_MAX_SEGMENT_SIZE = 2, TCP_OPTION_WINDOW_SCALE_FACTOR = 3, TCP_OPTION_SACK_PERMITTED = 4, TCP_OPTION_SACK = 5, TCP_OPTION_TIMESTAMP = 8 } |
| TCP option types. More... | |
Functions | |
| error_t | tcpInit (void) |
| TCP related initialization. More... | |
| uint16_t | tcpGetDynamicPort (void) |
| Get an ephemeral port number. More... | |
| error_t | tcpConnect (Socket *socket, const IpAddr *remoteIpAddr, uint16_t remotePort) |
| Establish a TCP connection. More... | |
| error_t | tcpListen (Socket *socket, uint_t backlog) |
| Place a socket in the listening state. More... | |
| Socket * | tcpAccept (Socket *socket, IpAddr *clientIpAddr, uint16_t *clientPort) |
| Permit an incoming connection attempt on a TCP socket. More... | |
| error_t | tcpSend (Socket *socket, const uint8_t *data, size_t length, size_t *written, uint_t flags) |
| Send data to a connected socket. More... | |
| error_t | tcpReceive (Socket *socket, uint8_t *data, size_t size, size_t *received, uint_t flags) |
| Receive data from a connected socket. More... | |
| error_t | tcpShutdown (Socket *socket, uint_t how) |
| Shutdown gracefully reception, transmission, or both. More... | |
| error_t | tcpAbort (Socket *socket) |
| Abort an existing TCP connection. More... | |
| TcpState | tcpGetState (Socket *socket) |
| Get the current state of the TCP FSM. More... | |
| Socket * | tcpKillOldestConnection (void) |
| Kill the oldest socket in the TIME-WAIT state. More... | |
Variables | |
| systime_t | tcpTickCounter |
Detailed Description
TCP (Transmission Control Protocol)
License
SPDX-License-Identifier: GPL-2.0-or-later
Copyright (C) 2010-2023 Oryx Embedded SARL. All rights reserved.
This file is part of CycloneTCP Open.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- Version
- 2.2.4
Definition in file tcp.h.
Macro Definition Documentation
◆ TCP_2MSL_TIMER
◆ TCP_CMP_SEQ
◆ TCP_CONGEST_CONTROL_SUPPORT
◆ TCP_DEFAULT_KEEP_ALIVE_IDLE
◆ TCP_DEFAULT_KEEP_ALIVE_INTERVAL
◆ TCP_DEFAULT_KEEP_ALIVE_PROBES
◆ TCP_DEFAULT_MSS
◆ TCP_DEFAULT_PROBE_INTERVAL
◆ TCP_DEFAULT_RX_BUFFER_SIZE
◆ TCP_DEFAULT_SYN_QUEUE_SIZE
◆ TCP_DEFAULT_TX_BUFFER_SIZE
◆ TCP_FAST_RETRANSMIT_THRES
◆ TCP_FIN_WAIT_2_TIMER
◆ TCP_INITIAL_RTO
◆ TCP_INITIAL_WINDOW
◆ TCP_KEEP_ALIVE_SUPPORT
◆ TCP_LOSS_WINDOW
◆ TCP_MAX_HEADER_LENGTH
◆ TCP_MAX_MSS
◆ TCP_MAX_PROBE_INTERVAL
◆ TCP_MAX_RETRIES
◆ TCP_MAX_RTO
◆ TCP_MAX_RX_BUFFER_SIZE
◆ TCP_MAX_SACK_BLOCKS
◆ TCP_MAX_SYN_QUEUE_SIZE
◆ TCP_MAX_TX_BUFFER_SIZE
◆ TCP_MIN_MSS
◆ TCP_MIN_RTO
◆ TCP_OVERRIDE_TIMEOUT
◆ TCP_SACK_SUPPORT
◆ TCP_SECURE_ISN_SUPPORT
◆ TCP_SUPPORT
◆ TCP_TICK_INTERVAL
Typedef Documentation
◆ TcpHeader
| typedef { ... } TcpHeader |
TCP header.
◆ TcpOption
| typedef { ... } TcpOption |
TCP option.
◆ TcpQueueItem
| typedef struct _TcpQueueItem TcpQueueItem |
Retransmission queue item.
◆ TcpSynQueueItem
| typedef struct _TcpSynQueueItem TcpSynQueueItem |
SYN queue item.
Enumeration Type Documentation
◆ TcpCongestState
| enum TcpCongestState |
◆ TcpFlags
| enum TcpFlags |
◆ TcpOptionKind
| enum TcpOptionKind |
◆ TcpState
| enum TcpState |
Function Documentation
◆ tcpAbort()
◆ tcpAccept()
Permit an incoming connection attempt on a TCP socket.
- Parameters
-
[in] socket Handle to a socket previously placed in a listening state [out] clientIpAddr IP address of the client [out] clientPort Port number used by the client
- Returns
- Handle to the socket in which the actual connection is made
◆ tcpConnect()
◆ tcpGetDynamicPort()
| uint16_t tcpGetDynamicPort | ( | void | ) |
◆ tcpGetState()
◆ tcpInit()
| error_t tcpInit | ( | void | ) |
◆ tcpKillOldestConnection()
| Socket* tcpKillOldestConnection | ( | void | ) |
◆ tcpListen()
Place a socket in the listening state.
Place a socket in a state in which it is listening for an incoming connection
- Parameters
-
[in] socket Socket to place in the listening state [in] backlog backlog The maximum length of the pending connection queue. If this parameter is zero, then the default backlog value is used instead
- Returns
- Error code
◆ tcpReceive()
| error_t tcpReceive | ( | Socket * | socket, |
| uint8_t * | data, | ||
| size_t | size, | ||
| size_t * | received, | ||
| uint_t | flags | ||
| ) |
Receive data from a connected socket.
- Parameters
-
[in] socket Handle that identifies a connected socket [out] data Buffer where to store the incoming data [in] size Maximum number of bytes that can be received [out] received Number of bytes that have been received [in] flags Set of flags that influences the behavior of this function
- Returns
- Error code
◆ tcpSend()
| error_t tcpSend | ( | Socket * | socket, |
| const uint8_t * | data, | ||
| size_t | length, | ||
| size_t * | written, | ||
| uint_t | flags | ||
| ) |
Send data to a connected socket.
- Parameters
-
[in] socket Handle that identifies a connected socket [in] data Pointer to a buffer containing the data to be transmitted [in] length Number of bytes to be transmitted [out] written Actual number of bytes written (optional parameter) [in] flags Set of flags that influences the behavior of this function
- Returns
- Error code
◆ tcpShutdown()
Shutdown gracefully reception, transmission, or both.
Note that socketShutdown() does not close the socket, and resources attached to the socket will not be freed until socketClose() is invoked
- Parameters
-
[in] socket Handle to a socket [in] how Flag that describes what types of operation will no longer be allowed
- Returns
- Error code