NetTCP_ConnCfgTxKeepAliveRetryTimeout
Configure TCP connection's transmit keep-alive retry timeout.
Files
net_tcp.h/net_tcp.c
Prototype
CPU_BOOLEAN NetTCP_ConnCfgTxKeepAliveRetryTimeout(NET_TCP_CONN_ID conn_id_tcp, NET_TCP_TIMEOUT_SEC timeout_sec, NET_ERR *perr);
Arguments
conn_id_tcp
Handle identifier of TCP connection to configure transmit keep-alive retry timeout.
timeout_sec
Desired value for TCP connection transmit keep-alive retry 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 transmit keep-alive retry timeout successfully configured;
DEF_FAIL
,
otherwise.
Required Configuration
Available only if TCP is enabled (see TCP Layer Configuration).
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 NetSock_GetConnTransportID):
NET_SOCK_ID sock_id; NET_TCP_CONN_ID conn_id_tcp; NET_ERR err; sock_id = Application's TCP socket ID; /* Get application's TCP socket ID. */ /* Get socket's TCP connection ID. */ conn_id_tcp = (NET_TCP_CONN_ID)NetSock_GetConnTransportID(sock_id, &err); if (err == NET_SOCK_ERR_NONE) { /* If NO errors, ... */ /* ... configure TCP connection Nagle algorithm. */ NetTCP_ConnCfgTxKeepAliveRetryTimeout(conn_id_tcp, 20u, &err); }
NetTCP_ConnCfgTxKeepAliveRetryTimeout()
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.