NetSock_CfgTimeoutConnReqGet_ms() (TCP)
Get socket’s connection request timeout value.
Files
net_sock.h/net_sock.c
Prototype
CPU_INT32U NetSock_CfgTimeoutConnReqGet_ms(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_LOCK
Returned Value
0,
on any errors;
NET_TMR_TIME_INFINITE,
if infinite (i.e., no timeout) value configured;
Timeout in number of milliseconds, 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.