Client - SetOptions

[C]

__cdecl FlowSshC_Client_SetOptions(
  FlowSshC_Client* client,
  bool startKeyReExchange,
  int sendBasedKeepAliveTimeoutMs,
  int recvBasedKeepAliveTimeoutMs,
  int recvBasedUnresponsivenessTimeoutMs);

[C++]

[Client] void SetOptions(
  bool startKeyReExchange,
  int sendBasedKeepAliveTimeoutMs,
  int recvBasedKeepAliveTimeoutMs,
  int recvBasedUnresponsivenessTimeoutMs);

[C#]

[ClientBase] public void SetOptions(
  bool startKeyReExchange,
  int sendBasedKeepAliveTimeoutMs,
  int recvBasedKeepAliveTimeoutMs,
  int recvBasedUnresponsivenessTimeoutMs);

Parameters

  • [C] client: FlowSshC_Client pointer.
  • startKeyReExchange: Whether FlowSsh should start key re-exchange. Enabled by default.
  • sendBasedKeepAliveTimeoutMs: Use 0 to disable send-based keep-alive, -1 to use the default value in FlowSsh, or specify your own value in milliseconds.
  • recvBasedKeepAliveTimeoutMs: Use 0 to disable receive-based keep-alive, -1 to use the default value in FlowSsh, or specify your own value in milliseconds.
  • recvBasedUnresponsivenessTimeoutMs: Use 0 to disable receive-based unresponsiveness timeout, -1 to use the default value in FlowSsh, or specify your own value in milliseconds.

Remarks

Key re-exchange and keep-alive are enabled by default, and do not need to be enabled explicitly by calling this method. If starting of key re-exchange is enabled, FlowSsh will start it every hour, or after every 1 GB of transferred data. If starting of key re-exchange is disabled, FlowSsh will still respond to key re-exchanges started by the server.