Network Socket Functions

Function Name	Description
`NET_SOCK_DESC_CLR()`	Remove a socket file descriptor ID as a member of a file descriptor set.
`NET_SOCK_DESC_COPY()`	Copy a file descriptor set to another file descriptor set.
`NET_SOCK_DESC_INIT()`	Initialize/zero-clear a file descriptor set.
`NET_SOCK_DESC_IS_SET()`	Check if a socket file descriptor ID is a member of a file descriptor set.
`NET_SOCK_DESC_SET()`	Add a socket file descriptor ID as a member of a file descriptor set.
`NetSock_Accept()`	Wait for new socket connections on a listening server socket.
`NetSock_Bind()`	Assign network addresses to sockets.
`NetSock_CfgBlock()`	Configure a socket’s blocking mode.
`NetSock_CfgConnChildQ_SizeGet()`	Get socket's connection child queue size value.
`NetSock_CfgConnChildQ_SizeSet()`	Configure socket's child connection queue size.
`NetSock_CfgIF()`	Configure the interface that must be used by the socket.
`NetSock_CfgRxQ_Size()`	Configure socket's receive queue size.
`NetSock_CfgSecure()`	Configure a socket’s secure mode.
`NetSock_CfgSecureClientCommonName()`	Configure client socket's common name.
`NetSock_CfgSecureClientTrustCallBack()`	Configure client socket's trust call back function.
`NetSock_CfgSecureClientCertKey()`	Install certificate and key that must be used by a client for mutual authentication.
`NetSock_CfgSecureServerCertKeyInstall()`	Install certificate (CERT) and private key (KEY) from a buffer which must be used by a server.
`NetSock_CfgTimeoutConnAcceptDflt()`	Set socket’s connection accept timeout to configured-default value.
`NetSock_CfgTimeoutConnAcceptGet_ms()`	Get socket’s connection accept timeout value.
`NetSock_CfgTimeoutConnAcceptSet()`	Set socket’s connection accept timeout value.
`NetSock_CfgTimeoutConnCloseDflt()`	Set socket’s connection close timeout to configured-default value.
`NetSock_CfgTimeoutConnCloseGet_ms()`	Get socket’s connection close timeout value.
`NetSock_CfgTimeoutConnCloseSet()`	Set socket’s connection close timeout value.
`NetSock_CfgTimeoutConnReqDflt()`	Set socket’s connection request timeout to configured-default value.
`NetSock_CfgTimeoutConnReqGet_ms()`	Get socket’s connection request timeout value.
`NetSock_CfgTimeoutConnReqSet()`	Set socket’s connection request timeout value.
`NetSock_CfgTimeoutRxQ_Dflt()`	Set socket’s connection receive queue timeout to configured-default value.
`NetSock_CfgTimeoutRxQ_Get_ms()`	Get socket’s receive queue timeout value.
`NetSock_CfgTimeoutRxQ_Set()`	Set socket’s connection receive queue timeout value.
`NetSock_CfgTimeoutTxQ_Dflt()`	Set socket’s connection transmit queue timeout to configured-default value.
`NetSock_CfgTimeoutTxQ_Get_ms()`	Get socket’s transmit queue timeout value.
`NetSock_CfgTimeoutTxQ_Set()`	Set socket’s connection transmit queue timeout value.
`NetSock_CfgTxIP_TOS()`	Configure socket's transmit IPv4 Type of Service (TOS).
`NetSock_CfgTxIP_TTL_Multicast()`	Configure socket's transmit IPv4 multicast Time to live (TTL).
`NetSock_CfgTxIP_TTL()`	Configure socket's transmit IPv4 Time to Live (TTL).
`NetSock_CfgTxQ_Size()`	Configure socket's transmit queue size.
`NetSock_Close()`	Terminate communication and free a socket.
`NetSock_Conn()`	Connect a local socket to a remote socket address.
`NetSock_GetConnTransportID()`	Gets a socket’s transport layer connection handle ID (e.g., TCP connection ID) if available.
`NetSock_IsConn()`	Check if a socket is connected to a remote socket.
`NetSock_Listen()`	Set a socket to accept incoming connections.
`NetSock_Open()`	Create a datagram (i.e., UDP) or stream (i.e., TCP) type socket.
`NetSock_OptGet()`	Get the specified socket option from the `sock_id` socket.
`NetSock_OptSet()`	Set the specified socket option to the `sock_id` socket.
`NetSock_PoolStatGet()`	Get Network Sockets’ statistics pool.
`NetSock_PoolStatResetMaxUsed()`	Reset Network Sockets’ statistics pool’s maximum number of entries used.
`NetSock_RxData() / NetSock_RxDataFrom()`	Copy up to a specified number of bytes received from a remote socket into an application memory buffer.
`NetSock_Sel()`	Check if any sockets are ready for available read or write operations or error conditions.
`NetSock_SelAbort()`	Abort any tasks that are pending on a socket using the select functionality.
`NetSock_TxData() / NetSock_TxDataTo()`	Copy bytes from an application memory buffer into a socket to send to a remote socket.

µC/TCP-IP Documentation

Network Socket Functions

Related content