NetSock_CfgTimeoutConnCloseDflt() (TCP)

Unable to render {include} The included page could not be found.

Set socket’s connection close timeout to configured-default value.

Files

net_sock.h/net_sock.c

Prototype

CPU_BOOLEAN NetSock_CfgTimeoutConnCloseDflt(NET_SOCK_ID sock_id,

NET_ERR *perr);

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.

perr

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_ERR_INIT_INCOMPLETE

NET_OS_ERR_INVALID_TIME

NET_OS_ERR_LOCK

Returned Value

DEF_OK,

Socket connection close configured-default timeout successfully set;

DEF_FAIL,

otherwise.

Required Configuration

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

Notes / Warnings

None.