...
| Function Name | Description |
|---|---|
NetTCP_ConnCfgIdleTimeout() | Configure TCP connection’s idle timeout. |
Files
net_tcp.h/net_tcp.c
Prototype
Arguments
conn_id_tcp
TCP connection handle ID to configure connection handle timeout.
timeout_sec
Desired value for TCP connection idle timeout (in seconds).
perr
Pointer to variable that will receive the return error code from this function:
NET_TCP_ERR_NONE
NET_TCP_ERR_INVALID_ARG
NET_TCP_ERR_INVALID_CONN
NET_TCP_ERR_CONN_NOT_USED
NET_ERR_INIT_INCOMPLETE
NET_OS_ERR_LOCK
Returned Value
DEF_OK,
TCP connection’s idle timeout successfully configured.
DEF_FAIL,
otherwise.
Required Configuration
Available only if NET_CFG_TRANSPORT_LAYER_SEL is configured for TCP (see section D-12-1).
Notes / Warnings
Configured timeout does not reschedule any current idle timeout in progress but becomes effective the next time a TCP connection sets its idle timeout.
The conn_id_tcp argument represents the TCP connection handle – not the socket handle. The following code may be used to get the TCP connection handle and configure TCP connection parameters (see also section C-13-38 “NetSock_GetConnTransportID()”):
...
NetTCP_ConnCfgMaxSegSizeLocal() | Configure TCP connection’s local maximum segment size. |
NetTCP_ConnCfgMSL_Timeout() | Configure TCP connection's maximum segment lifetime (MSL) timeout. |
NetTCP_ConnCfgReTxMaxTh() | Configure TCP connection’s maximum number of same segment retransmissions. |
NetTCP_ConnCfgReTxMaxTimeout() | Configure TCP connection’s maximum retransmission timeout. |
NetTCP_ConnCfgRxWinSize() | Configure TCP connection’s receive window size. |
NetTCP_ConnCfgTxAckDlyTimeout() | Configure TCP connection's transmit acknowledgement delay timeout. |
NetTCP_ConnCfgTxAckImmedRxdPushEn() | Configure TCP connection’s transmit immediate acknowledgement for received and pushed TCP segments. |
NetTCP_ConnCfgTxKeepAliveEn() | Configure TCP connection's transmit keep-alive enable. |
NetTCP_ConnCfgTxKeepAliveRetryTimeout() | Configure TCP connection's transmit keep-alive retry timeout. |
NetTCP_ConnCfgTxKeepAliveTh() | Configure TCP connection's maximum number of consecutive keep-alives to transmit. |
NetTCP_ConnCfgTxNagleEn() | Configure TCP connection's transmit Nagle algorithm enable. |
NetTCP_ConnCfgTxWinSize() | Configure TCP connection’s transmit window size. |
NetTCP_ConnPoolStatGet() | Get TCP connections’ statistics pool. |
NetTCP_ConnPoolStatResetMaxUsed() | Reset TCP connections’ statistics pool’s maximum number of entries used. |
NetTCP_ConnStateGet() | Get the current state of the TCP connection. |