NetSock_Close

Terminate communication and free a socket.

Files

net_sock.h/net_sock.c net_bsd.h/net_bsd.c

Prototypes

NET_SOCK_RTN_CODE  NetSock_Close(NET_SOCK_ID  sock_id,
                                 NET_ERR     *p_err);

              int  close        (int          sock_id);

Arguments

sock_id

The socket ID returned by NetSock_Open()/socket() when the socket is created or by NetSock_Accept()/accept() when a connection is 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_CLOSED NET_SOCK_ERR_INVALID_SOCK NET_SOCK_ERR_INVALID_FAMILY NET_SOCK_ERR_INVALID_STATE NET_SOCK_ERR_CLOSE_IN_PROGRESS NET_SOCK_ERR_CONN_SIGNAL_TIMEOUT NET_SOCK_ERR_CONN_FAIL NET_SOCK_ERR_FAULT NET_CONN_ERR_NOT_USED NET_CONN_ERR_INVALID_CONN NET_INIT_ERR_NOT_COMPLETED NET_ERR_FAULT_LOCK_ACQUIRE

Returned Value

NET_SOCK_BSD_ERR_NONE/0, if successful;

NET_SOCK_BSD_ERR_CLOSE/-1, otherwise.

Required Configuration

None.

Notes / Warnings

After closing a socket, no further operations should be performed with the socket.

µC/TCP-IP Documentation