NetSock_CfgTimeoutConnCloseSet

Set socket’s connection close timeout value.

Files

net_sock.h/net_sock.c

Prototype

          CPU_BOOLEAN NetSock_CfgTimeoutConnCloseSet(NET_SOCK_ID  sock_id,
                                                     CPU_INT32U   timeout_ms,
                                                     NET_ERR     *p_err);

Arguments

sock_id

This is the socket ID returned by NetSock_Open()/socket() when the socket was created or by NetSock_Accept()/accept() when a connection was accepted.

timeout_ms

Desired timeout value:

NET_TMR_TIME_INFINITE, if infinite (i.e., no timeout) value desired.

In number of milliseconds, otherwise.

p_err

Pointer to variable that will receive the return error code from this function:

NET_SOCK_ERR_NONE
NET_SOCK_ERR_NOT_USED
NET_SOCK_ERR_INVALID_SOCK
NET_INIT_ERR_NOT_COMPLETED
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

DEF_OK,

Socket connection close timeout successfully set;

DEF_FAIL,

otherwise.

Required Configuration

Available only if NET_TCP_CFG_EN is enabled (see section TCP Layer Configuration).

Notes / Warnings

None.