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

Developer

API Reference

AEESOCKOPT

Brew Release
Brew MP 1.0.2
See Also
AEELinger INAddr ISockPort_GetOpt() ISockPort_SetOpt() Socket Protocols
Description
Used to set/get socket options.
Members
  • nLevel:    option level (see table below)
  • nOptName:  option name (see table below)
  • pOptVal:   pointer to the data type appropriate for the option (see table below)
  • pnOptSize: pointer to size of pOptVal
Definition
  •     typedef struct {
        int nLevel;
        int nOptName;
        void* pOptVal;
        int* pnOptSize;
        } AEESockOpt;
    
Comments
The socket options available are listed below. Not all options are supported on all devices. ---------------------------------------------------------------------------------------------------------------- Level | Option | Data Type | Description | -----------------+------------------------+-----------+---------------------------------------------------------| AEE_SOL_SOCKET | AEE_SO_KEEPALIVE | boolean | periodically test if connection is still alive | | AEE_SO_LINGER | AEELinger | linger on close if data to send | | AEE_SO_RCVBUF | int | receive buffer size | | AEE_SO_SNDBUF | int | send buffer size | | AEE_SO_REUSEADDR | boolean | enable to reuse a pair of address and port number | | | | that is already bound by another socket. Currently, | | | | this socket option is supported only for multicast, | | | | UDP sockets. In Brew this option is currently not | | | | supported for Brew loopback sockets and for sockets | | | | that bind to the AEE_INADDR_ANY address. | | AEE_SO_DISABLE_FLOW_ | boolean | disables routing data on best effort flow when | | FWDING | | QoS is not available | | AEE_SO_ERROR_ENABLE | boolean | enable retrieving of ICMP errors using SO_ERROR | | AEE_SO_ERROR | int | get ICMP error on the socket (cannot be set) | | AEE_SO_SDB_ACK_CB | | Only applicable to CDMA networks. Used to retrieve or | | | | register a callback that is invoked when the mobile | | | | receives an SDB/DOS data ACK from the base station. | -----------------+------------------------+-----------+---------------------------------------------------------| AEE_IPPROTO_TCP | AEE_TCP_NODELAY | boolean | disable Nagle algorithm | | AEE_TCP_DELAYED_ACK | boolean | enable delayed ack | | AEE_TCP_SACK | boolean | enable SACK | | AEE_TCP_TIME_STAMP | boolean | enable TCP time stamp option | | AEE_TCP_FIONREAD | uint32 | Retrieve TCP queue size (cannot be set) | | AEE_TCP_MAXSEG | int | Change the TCP maximum segment size | -----------------+------------------------+-----------+---------------------------------------------------------| AEE_IPPROTO_IP | AEE_IP_ADD_MEMBERSHIP | INAddr | join a multicast group | | AEE_IP_DROP_MEMBERSHIP | INAddr | leave a multicast group | | AEE_IP_TOS | int | determine Type of Service | | AEE_IP_TTL | int | Change the Time To Live value | | AEE_IP_RECVERR | boolean | enable retrieving of ICMP error info using | | | | ISockPort_RecvMsg() | -----------------+------------------------+-----------+---------------------------------------------------------| AEE_IPPROTO_IPV6 | AEE_IPV6_TCLASS | int | determine Traffic Class | ---------------------------------------------------------------------------------------------------------------