IPWorks SSH 2020 Node.js Edition

Questions / Feedback?

SSHChannelReadyToSend Event

Fired when the class is ready to send data.

Syntax

sshclient.on('SSHChannelReadyToSend', [callback])

Callback

The 'callback' is called when the 'SSHChannelReadyToSend' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.channelId

Remarks

This event fires when data can be sent over the SSH Channel specified by ChannelId.

When a channel is opened this event will fire once the channel is ready and data can be sent.

When Timeout is set to 0 (asynchronous) sending data may result in an error if the channel or underlying socket cannot accept more data to send. Monitor SSHChannelReadyToSend or ReadyToSend to determine when data can be sent again.

When Timeout is set to a positive value the class will block when sending data until the data can be successfully sent and SSHChannelReadyToSend and ReadyToSend do not need to be monitored.

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