|
FreeRTOS-Plus-TCP V2.3.2
FreeRTOS TCP/IP library
|
|
|
FreeRTOS-Plus-TCP V2.3.2
FreeRTOS TCP/IP library
|
|
#include <FreeRTOS_IP_Private.h>
Note that the values of all short and long integers in these structs are being stored in the native-endian way Translation should take place when accessing any structure which defines network packets, such as IPHeader_t and TCPHeader_t
| uint32_t IPTCPSocket_t::ulRemoteIP |
IP address of remote machine
| uint16_t IPTCPSocket_t::usRemotePort |
Port on remote machine
| uint32_t IPTCPSocket_t::bMssChange |
This socket has seen a change in MSS
| uint32_t IPTCPSocket_t::bPassAccept |
when true, this socket may be returned in a call to accept()
| uint32_t IPTCPSocket_t::bPassQueued |
when true, this socket is an orphan until it gets connected Why an orphan? Because it may not be returned in a accept() call until it gets the state eESTABLISHED
| uint32_t IPTCPSocket_t::bReuseSocket |
When a listening socket gets a connection, do not create a new instance but keep on using it
| uint32_t IPTCPSocket_t::bCloseAfterSend |
As soon as the last byte has been transmitted, finalise the connection Useful in e.g. FTP connections, where the last data bytes are sent along with the FIN flag
| uint32_t IPTCPSocket_t::bUserShutdown |
User requesting a graceful shutdown
| uint32_t IPTCPSocket_t::bCloseRequested |
Request to finalise the connection
| uint32_t IPTCPSocket_t::bLowWater |
high-water level has been reached. Cleared as soon as 'rx-count < lo-water'
| uint32_t IPTCPSocket_t::bWinChange |
The value of bLowWater has changed, must send a window update
| uint32_t IPTCPSocket_t::bSendKeepAlive |
When this flag is true, a TCP keep-alive message must be send
| uint32_t IPTCPSocket_t::bWaitKeepAlive |
When this flag is true, a TCP keep-alive reply is expected
| uint32_t IPTCPSocket_t::bConnPrepared |
Connecting socket: Message has been prepared
| uint32_t IPTCPSocket_t::bConnPassed |
Connecting socket: Socket has been passed in a successful select()
| uint32_t IPTCPSocket_t::bFinAccepted |
This socket has received (or sent) a FIN and accepted it
| uint32_t IPTCPSocket_t::bFinSent |
We've sent out a FIN
| uint32_t IPTCPSocket_t::bFinRecv |
We've received a FIN from our peer
| uint32_t IPTCPSocket_t::bFinAcked |
Our FIN packet has been acked
| uint32_t IPTCPSocket_t::bFinLast |
The last ACK (after FIN and FIN+ACK) has been sent or will be sent by the peer
| uint32_t IPTCPSocket_t::bRxStopped |
Application asked to temporarily stop reception
| uint32_t IPTCPSocket_t::bMallocError |
There was an error allocating a stream
| uint32_t IPTCPSocket_t::bWinScaling |
A TCP-Window Scaling option was offered and accepted in the SYN phase.
| struct { ... } IPTCPSocket_t::bits |
The bits structure
| uint32_t IPTCPSocket_t::ulHighestRxAllowed |
The highest sequence number that we can receive at any moment
| uint16_t IPTCPSocket_t::usTimeout |
Time (in ticks) after which this socket needs attention
| uint16_t IPTCPSocket_t::usCurMSS |
Current Maximum Segment Size
| uint16_t IPTCPSocket_t::usInitMSS |
Initial maximum segment Size
| uint16_t IPTCPSocket_t::usChildCount |
In case of a listening socket: number of connections on this port number
| uint16_t IPTCPSocket_t::usBacklog |
In case of a listening socket: maximum number of concurrent connections on this port number
| uint8_t IPTCPSocket_t::ucRepCount |
Send repeat count, for retransmissions This counter is separate from the xmitCount in the TCP win segments
| uint8_t IPTCPSocket_t::ucTCPState |
TCP state: see eTCP_STATE
| struct xSOCKET* IPTCPSocket_t::pxPeerSocket |
for server socket: child, for child socket: parent
| TickType_t IPTCPSocket_t::xLastActTime |
The last time when hang-protection was done.
| size_t IPTCPSocket_t::uxLittleSpace |
The value deemed as low amount of space.
| size_t IPTCPSocket_t::uxEnoughSpace |
The value deemed as enough space.
| size_t IPTCPSocket_t::uxRxStreamSize |
The Receive stream size
| size_t IPTCPSocket_t::uxTxStreamSize |
The transmit stream size
| StreamBuffer_t* IPTCPSocket_t::rxStream |
The pointer to the receive stream buffer.
| StreamBuffer_t* IPTCPSocket_t::txStream |
The pointer to the transmit stream buffer.
| NetworkBufferDescriptor_t* IPTCPSocket_t::pxAckMessage |
The pointer to the ACK message
| LastTCPPacket_t IPTCPSocket_t::xPacket |
Buffer space to store the last TCP header received.
| uint8_t IPTCPSocket_t::tcpflags |
TCP flags
| uint8_t IPTCPSocket_t::ucMyWinScaleFactor |
Scaling factor of this device.
| uint8_t IPTCPSocket_t::ucPeerWinScaleFactor |
Scaling factor of the peer.
| uint32_t IPTCPSocket_t::ulWindowSize |
Current Window size advertised by peer
| size_t IPTCPSocket_t::uxRxWinSize |
Fixed value: size of the TCP reception window
| size_t IPTCPSocket_t::uxTxWinSize |
Fixed value: size of the TCP transmit window
| TCPWindow_t IPTCPSocket_t::xTCPWindow |
The TCP window struct
1.9.2