TCPIP_TCP_OptionsSet Function

C

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

Description

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

Preconditions

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

Parameters

ParametersDescription
hTCPSocket to set options for.
optionSpecific option to be set.
optParamThe option value; this is option dependent. - 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 - boolean to enable/disable the NO DELAY functionality - TCP_OPTION_EXCLUSIVE_ADDRESS - not supported yet - TCP_OPTION_THRES_FLUSH - a TCP_OPTION_THRES_FLUSH_TYPE - TCP_OPTION_DELAY_SEND_ALL_ACK - boolean to enable/disable the DELAY Send All ACK data functionality - TCP_OPTION_TX_TTL - 8-bit value of TTL - TCP_OPTION_TOS - 8-bit value of the TOS

Returns

  • True - Indicates success.

  • False - Indicates failure.

Remarks

None.