NetSock_GetConnTransportID

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.

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_SOCK_ERR_INVALID_TYPE
NET_CONN_ERR_NOT_USED
NET_CONN_ERR_INVALID_CONN
NET_INIT_ERR_NOT_COMPLETED
NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

Socket’s transport connection handle ID (e.g., TCP connection ID), if no errors.

NET_CONN_ID_NONE, otherwise.

Required Configuration

None.

Notes / Warnings

None.