C# Class Granados.Poderosa.SCP.SCPChannelStream

Channel stream for SCPClient
Inheritance: IDisposable
Mostrar archivo Open project: poderosaproject/poderosa Class Usage Examples

Private Properties

Property Type Description
OnChannelStatusChanged void
OnDataReceived void
OpenForTest void

Public Methods

Method Description
Close ( ) : void

Close channel.

Dispose ( ) : void

IDisposable implementation

GetPreferredDatagramSize ( ) : int

Gets preferred datagram size.

Open ( ISSHConnection connection, string command, int millisecondsTimeout ) : void

Opens channel.

Read ( byte buffer, int millisecondsTimeout ) : int

Reads data

Read ( byte buffer, int maxLength, int millisecondsTimeout ) : int

Reads data

ReadByte ( int millisecondsTimeout ) : byte

Read one byte

ReadUntil ( byte terminator, int millisecondsTimeout ) : byte[]

Read data until specified byte value is read.

SCPChannelStream ( ) : System

Constructor

Write ( byte buffer ) : void

Writes data.

Write ( byte buffer, int length ) : void

Writes data.

Private Methods

Method Description
OnChannelStatusChanged ( SCPChannelStatus newStatus ) : void
OnDataReceived ( Granados.IO.DataFragment data ) : void
OpenForTest ( SSHChannel dummyChannel ) : void

Method Details

Close() public method

Close channel.
public Close ( ) : void
return void

Dispose() public method

IDisposable implementation
public Dispose ( ) : void
return void

GetPreferredDatagramSize() public method

Gets preferred datagram size.
public GetPreferredDatagramSize ( ) : int
return int

Open() public method

Opens channel.
Channel has been already opened or already closed. Timeout has occurred while waiting for READY status.
public Open ( ISSHConnection connection, string command, int millisecondsTimeout ) : void
connection ISSHConnection SSH connection object
command string Remote command
millisecondsTimeout int timeout in milliseconds
return void

Read() public method

Reads data
Timeout has occurred
public Read ( byte buffer, int millisecondsTimeout ) : int
buffer byte Byte array to store the data
millisecondsTimeout int Timeout in milliseconds
return int

Read() public method

Reads data
Timeout has occurred
public Read ( byte buffer, int maxLength, int millisecondsTimeout ) : int
buffer byte Byte array to store the data
maxLength int Maximum bytes to read
millisecondsTimeout int Timeout in milliseconds
return int

ReadByte() public method

Read one byte
Timeout has occurred
public ReadByte ( int millisecondsTimeout ) : byte
millisecondsTimeout int Timeout in milliseconds
return byte

ReadUntil() public method

Read data until specified byte value is read.
Timeout has occurred Buffer overflow
public ReadUntil ( byte terminator, int millisecondsTimeout ) : byte[]
terminator byte Byte value to stop reading
millisecondsTimeout int Timeout in milliseconds
return byte[]

SCPChannelStream() public method

Constructor
public SCPChannelStream ( ) : System
return System

Write() public method

Writes data.
public Write ( byte buffer ) : void
buffer byte Buffer
return void

Write() public method

Writes data.
public Write ( byte buffer, int length ) : void
buffer byte Buffer
length int Length
return void