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

Developer

API Reference

ISOCKET_GETOPT()

Brew Release
Brew MP 1.0.2
See Also
ISOCKET_SetOpt() ISOCKET_Readable() AEESockOpt
Description
Gets options for a socket.
Params
pISocket
[in]:
Pointer to the ISocket Interface whose name is to be returned.
nLevel
[in]:
Option level (see AEESockOpt)
nOptName
[in]:
Option name (see AEESockOpt)
pOptVal
[out]:
Pointer to the data type appropriate for the option (see AEESockOpt)
pnOptSize
[]:
[in/out] : Pointer to size of pOptVal
Interface
  • ISOCKET
Prototype
  •     int ISOCKET_GetOpt
        (
        ISocket * pISocket,
        int nLevel,
        int nOptName,
        void *pOptVal,
        int* pnOptSize
        )
    
Return
  • AEE_NET_SUCCESS: The socket option has been successfully retrieved. AEE_NET_WOULDBLOCK: Operation in progress; use ISOCKET_Readable() to be notified when to try again. AEE_NET_ERROR: The operation failed. The specific error code can be retrieved by calling ISOCKET_GetLastError().
Side Effect
  • None.
Comments
This is not a formal member of ISocket, instead it is a wrapper around ISOCKET_IOCtl()