API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

ISOCKET_CLOSE()

Brew Release
Brew MP 1.0.2
See Also
ISOCKET_Readable() ISOCKET_Writeable()
Description
Causes a socket to be closed. In the case of TCP, any connection will be terminated gracefully. The last ISOCKET_Release() implicitly performs a close in the background. Prior to the last ISOCKET_Release(), ISOCKET_Close() can be called in order to - Explicitly begin the close process, and/or
- Determine when the socket close process is complete.

The operation will fail if the socket has not been implicitly or explicitly Realized.
Params
ps
[]:
Pointer to the ISocket interface to close
Interface
  • ISOCKET
Prototype
  •    int ISOCKET_Close(ISocket * ps);
    
Return
  • AEE_NET_SUCCESS: The socket has been successfully closed. AEE_NET_WOULDBLOCK: Close in progress; use either ISOCKET_Readable() or ISOCKET_Writeable() to be notified when to try again. AEE_NET_ERROR: The operation failed. The specific error code can be retrieved by calling ISOCKET_GetLastError().
Comments
This is not a formal member of ISocket, instead it is a wrapper around ISOCKET_IOCtl()