NetTCP_ConnCfgReTxMaxTimeout()

Configure TCP connection’s maximum retransmission timeout.

Files

net_tcp.h/net_tcp.c

Prototype

Arguments

conn_id_tcp

TCP connection handle ID to configure maximum retransmission timeout value.

timeout_sec

Desired value for TCP connection maximum retransmission 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 maximum retransmission timeout successfully configured, if no errors.

DEF_FAIL,

otherwise.

Required Configuration

Available only if NET_CFG_TRANSPORT_LAYER_SEL is configured for TCP (see section D-12-1).

Notes / Warnings

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_ConnCfgReTxMaxTimeout() is called by application function(s) and must not be called with the global network lock already acquired. It must block all other network protocol tasks by pending on and acquiring the global network lock (see “net.h Note #3”). This is required since an application's network protocol suite API function access is asynchronous to other network protocol tasks.