SmartFTP FTP Library
ISocketSettings Interface Reference

import "sfFTPLib.idl";

Properties

long SendBufferSize [get, set]
 The size of the send buffer in bytes.
long ReceiveBufferSize [get, set]
 The size of the receive buffer in bytes.
VARIANT_BOOL AutoTuneSendBufferSize [get, set]
 Enables or disables the application of the custom send buffer size.
VARIANT_BOOL AutoTuneReceiveBufferSize [get, set]
 Enables or disables the application of the custom receive buffer size.
VARIANT_BOOL TcpNoDelay [get, set]
 Controls the TCP_NODELAY socket option (Nagle's algorithm).

Property Documentation

◆ AutoTuneReceiveBufferSize

VARIANT_BOOL ISocketSettings::AutoTuneReceiveBufferSize
getsetproperty

Enables or disables the application of the custom receive buffer size.

This property acts as a toggle for the ReceiveBufferSize setting.

  • Set (Put): Determines if the SO_RCVBUF socket option is explicitly set to the ReceiveBufferSize value.
  • Get: Retrieves the current configuration state.

Default: TRUE (Enabled)

Parameters
[in]newValueThe state to set. VARIANT_TRUE enables the custom buffer size; VARIANT_FALSE uses the system default.
[out]retvalPointer to a VARIANT_BOOL that receives the current state.

◆ AutoTuneSendBufferSize

VARIANT_BOOL ISocketSettings::AutoTuneSendBufferSize
getsetproperty

Enables or disables the application of the custom send buffer size.

This property acts as a toggle for the SendBufferSize setting.

  • Set (Put): Determines if the SO_SNDBUF socket option is explicitly set to the SendBufferSize value.
  • Get: Retrieves the current configuration state.

Default: VARIANT_TRUE (Enabled)

Parameters
[in]newValueThe state to set. VARIANT_TRUE enables the custom buffer size; VARIANT_FALSE uses the system default.
[out]retvalPointer to a VARIANT_BOOL that receives the current state.

◆ ReceiveBufferSize

long ISocketSettings::ReceiveBufferSize
getsetproperty

The size of the receive buffer in bytes.

This value is used to set the SO_RCVBUF socket option if AutoTuneReceiveBufferSize is set to TRUE.

Parameters
[in]newValueThe new buffer size in bytes. Default: 131,072 (128 KB).

◆ SendBufferSize

long ISocketSettings::SendBufferSize
getsetproperty

The size of the send buffer in bytes.

This value is used to set the SO_SNDBUF socket option if AutoTuneSendBufferSize is set to TRUE.

Parameters
[in]newValueThe new buffer size in bytes. Default: 131,072 (128 KB).

◆ TcpNoDelay

VARIANT_BOOL ISocketSettings::TcpNoDelay
getsetproperty

Controls the TCP_NODELAY socket option (Nagle's algorithm).

This property determines whether the socket buffers small packets or sends them immediately.

  • Set (Put): Sets the state of the TCP_NODELAY socket option.
  • Get: Retrieves the current configuration state.

Default: VARIANT_FALSE

Configuration:

  • TRUE: Nagle's algorithm is disabled. Data is sent immediately (lower latency, higher network overhead).
  • FALSE: Nagle's algorithm is enabled. Small data packets are buffered/coalesced (higher latency, better bandwidth efficiency).
Parameters
[in]newValueThe state to set. VARIANT_TRUE disables the delay; VARIANT_FALSE enables buffering.
[out]retvalPointer to a VARIANT_BOOL that receives the current state.
The documentation for this interface was generated from the following file: