NetSock_CfgConnChildQ_SizeGet() (TCP)
Get socket's connection child queue size value.
Files
net_sock.h/net_sock.c
Prototype
CPU_BOOLEAN NetSock_CfgConnChildQ_SizeGet(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.
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_PROTOCOL
NET_SOCK_ERR_INVALID_TYPE
NET_SOCK_ERR_INVALID_STATE
NET_SOCK_ERR_INVALID_SOCK
NET_ERR_INIT_INCOMPLETE
NET_TCP_ERR_CONN_NOT_USED
NET_TCP_ERR_INVALID_ARG
NET_TCP_ERR_INVALID_CONN
NET_CONN_ERR_INVALID_CONN
NET_CONN_ERR_NOT_USED
NET_OS_ERR_LOCK
Returned Value
Socket's connection child queue size value:
NET_SOCK_Q_SIZE_NONE
on any error(s).
NET_SOCK_Q_SIZE_UNLIMITED
if unlimited (i.e., no limit) value configured.
child connection queue size, otherwise.
Required Configuration
None.
Notes / Warnings
Available only for stream-type sockets (e.g., TCP sockets).