1.2.3.1.33 TCPIP_TCP_OptionsGet Function

C

bool TCPIP_TCP_OptionsGet(
    TCP_SOCKET hTCP, 
    TCP_SOCKET_OPTION option, 
    void* optParam
);

Various options can be get at the socket level. This function provides compatibility with BSD implementations.

TCP socket should have been opened with TCPIP_TCP_ServerOpen()/TCPIP_TCP_ClientOpen(). hTCP - valid socket.


Parameters	Description
hTCP	Socket to set options for.
option	Specific option to be set.
optParam	pointer to an area that will receive the option value; this is option dependent the size of the area has to be large enough to accommodate the specific option - TCP_OPTION_LINGER - pointer to a TCP_OPTION_LINGER_DATA structure - TCP_OPTION_KEEP_ALIVE - pointer to a TCP_OPTION_KEEP_ALIVE_DATA structure - TCP_OPTION_RX_BUFF - size of the new RX buffer - TCP_OPTION_TX_BUFF - size of the new TX buffer - TCP_OPTION_RX_TMO - not supported yet - TCP_OPTION_TX_TMO - not supported yet - TCP_OPTION_NODELAY - pointer to boolean to return current NO DELAY status - TCP_OPTION_EXCLUSIVE_ADDRESS - not supported yet - TCP_OPTION_THRES_FLUSH - a TCP_OPTION_THRES_FLUSH_TYPE - TCP_OPTION_DELAY_SEND_ALL_ACK - pointer to boolean to return current DELAY Send All ACK status - TCP_OPTION_TX_TTL - pointer to an 8 bit value to receive the TTL value - TCP_OPTION_TOS - pointer to an 8 bit value to receive the TOS

None.