SecureBlackbox Lite 2020 Node.js Edition

Questions / Feedback?

SSHSettingsHandshakeTimeout Property

Specifies the maximal time for the SSH handshake to proceed, in seconds.

Syntax

 sftpclient.getSSHSettingsHandshakeTimeout([callback])
 sftpclient.setSSHSettingsHandshakeTimeout( SSHSettingsHandshakeTimeout, [callback])

Default Value

45

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSSHSettingsHandshakeTimeout([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSSHSettingsHandshakeTimeout([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Specifies the maximal time for the SSH handshake to proceed, in seconds. If the handshake is not completed within this period, the session is aborted.

Data Type

Integer

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox Lite 2020 Node.js Edition - Version 20.0 [Build 8166]