close

Synchronous close function, releases all the socket assigned resources.

Functions
NMI_API sint8	close (SOCKET sock)

NMI_API sint8 close

(

SOCKET

sock

)

Parameters

[in]

sock

Socket ID, must hold a non negative value. A negative value will return a socket error SOCK_ERR_INVALID_ARG. Indicating that an invalid argument is passed in.

Precondition

Sockets must be initialized through the call of the socketInit function. close is called only for valid socket identifiers created through the socket function.

Warning

If close is called while there are still pending messages (sent or received ) they will be discarded.

See Also

socketInit socket

Returns

The function returned SOCK_ERR_NO_ERROR for successful operation and a negative value (indicating the error) otherwise.

References M2M_INFO, m2m_memset(), MAX_SOCKET, NULL, tstrCloseCmd::sock, SOCK_ERR_INVALID, SOCK_ERR_INVALID_ARG, SOCK_ERR_NO_ERROR, SOCKET_CMD_CLOSE, SOCKET_CMD_SSL_CLOSE, SOCKET_REQUEST, SSL_FLAGS_ACTIVE, tstrCloseCmd::u16SessionID, and tstrSocket::u16SessionID.

Referenced by AppServerCb(), GROWL_APPSocketEventHandler(), and NMI_GrowldeInit().