IPWorks SSH 2020 Node.js Edition

Questions / Feedback?

ClientReadyToSend Property

Indicates whether the class is ready to send data.

Syntax

 sshtunnel.getClientReadyToSend(index, [callback])

Default Value

FALSE

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 getClientReadyToSend([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 setClientReadyToSend([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

Indicates whether the class is ready to send data.

This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is True after a client connects, and will become False after a failed ClientDataToSend.

After a failed ClientDataToSend the ReadyToSend event will fire and this property will be True when data can be sent again.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the ClientCount property.

This property is read-only and not available at design time.

Data Type

Boolean

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks SSH 2020 Node.js Edition - Version 20.0 [Build 8501]