SSHChannel Type
A currently open SSH channel.
Remarks
This type describes the SSH client's currently open channels. You may use the different fields of this type to manage the channel.
Fields
|
bytesSent Int32 |
The number of bytes actually sent after a sending channel data. |
|
channelId String |
An id generated by the class to identify the current SSH channel. This id is unique to this channel. |
|
dataToSendB Data |
A string of data to be sent to the remote host. Write-only property. Assigning a string to the DataToSend makes the class send the string to the remote host. |
|
dataToSend String |
A string of data to be sent to the remote host. Write-only property. Assigning a string to the DataToSend makes the class send the string to the remote host. |
|
readyToSend Bool |
This property is True when data can be sent over the SSH Channel. 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. |
|
recordLength Int32 |
The length of received data records. If set to a positive value, this setting defines the length of data records to be received. The class will accumulate data until RecordLength is reached and only then fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event. The default value is 0, meaning this setting is not used. |
|
service String |
This property holds the channel type that was requested when opening the channel. For instance "session" or "forwarded-tcpip". |