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
Integer

The number of bytes actually sent after a sending channel data.

ChannelId
String

An id generated by the component to identify the current SSH channel. This id is unique to this channel.

DataToSend
String

A string of data to be sent to the remote host. Write-only property.

Assigning a string to the DataToSend makes the component send the string to the remote host.

DataToSendB
Byte[]

A string of data to be sent to the remote host. Write-only property.

Assigning a string to the DataToSend makes the component send the string to the remote host.

ReadyToSend
Boolean

This field 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 component will block when sending data until the data can be successfully sent and SSHChannelReadyToSend and ReadyToSend do not need to be monitored.

RecordLength
Integer

The length of received data records. If set to a positive value, this setting defines the length of data records to be received. The component 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 field holds the channel type that was requested when opening the channel. For instance "session" or "forwarded-tcpip".

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