Gets a socket’s transport layer connection handle ID (e.g., TCP connection ID) if available.
Files
net_sock.h/net_sock.c
Prototype
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_SOCK_ERR_INVALID_TYPE
NET_CONN_ERR_NOT_USED
NET_CONN_ERR_INVALID_CONN
NET_ERR_INIT_INCOMPLETE
NET_OS_ERR_LOCK
Returned Value
Socket’s transport connection handle ID (e.g., TCP connection ID), if no errors.
NET_CONN_ID_NONE, otherwise.
Required Configuration
Available only if either NET_CFG_TRANSPORT_LAYER_SEL is configured for TCP (see section D-12-1) and/or NET_UDP_CFG_APP_API_SEL is configured for sockets (see section D-13-1).
Notes / Warnings
None.