Tamir.SharpSsh.SshShell Class Reference

Summary description for SshShell. More...

Inheritance diagram for Tamir.SharpSsh.SshShell:

List of all members.

Public Member Functions

SshShell (string host, string user, string password)

SshShell (string host, string user)

void WriteLine (string data)

void Write (string data)

virtual void Write (byte[] buffer)

Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

virtual void Write (byte[] buffer, int offset, int count)

Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Stream GetStream ()

Creates a new I/O stream of communication with this SSH shell connection.

void SetStream (Stream inputStream, Stream outputStream)

void SetStream (Stream s)

void RedirectToConsole ()

string Expect ()

Reads a response string from the SSH channel. This method will block until the pattern in the 'Prompt' property is matched in the response.

string Expect (string pattern)

Reads a response string from the SSH channel. This method will block until the pattern in the 'Prompt' property is matched in the response.

string Expect (Regex pattern)

Reads a response string from the SSH channel. This method will block until the pattern in the 'Prompt' property is matched in the response.

Static Public Member Functions

static string HandleTerminalChars (string str)

Removes escape sequence characters from the input string.

Protected Member Functions

void Init ()

override void OnChannelReceived ()

Properties

override string ChannelType [get]

Stream IO [get]

virtual bool ShellOpened [get]

virtual bool ShellConnected [get]

bool RemoveTerminalEmulationCharacters [get, set]

Gets or sets a value indicating wether this Steam sould remove the terminal emulation's escape sequence characters from the response String.

string ExpectPattern [get, set]

A regular expression pattern string to match when reading the resonse using the ReadResponse() method. The default prompt value is "\n" which makes the ReadRespons() method return one line of response.

Detailed Description

Summary description for SshShell.

Definition at line 43 of file SshShell.cs.

Constructor & Destructor Documentation

Tamir.SharpSsh.SshShell.SshShell	(	string	host,
		string	user,
		string	password
	)

Definition at line 51 of file SshShell.cs.

Tamir.SharpSsh.SshShell.SshShell	(	string	host,
		string	user
	)

Definition at line 57 of file SshShell.cs.

Member Function Documentation

string Tamir.SharpSsh.SshShell.Expect ( Regex pattern )

Reads a response string from the SSH channel. This method will block until the pattern in the 'Prompt' property is matched in the response.

Returns:: A response string from the SSH server.

Definition at line 220 of file SshShell.cs.

string Tamir.SharpSsh.SshShell.Expect ( string pattern )

Reads a response string from the SSH channel. This method will block until the pattern in the 'Prompt' property is matched in the response.

Returns:: A response string from the SSH server.

Definition at line 211 of file SshShell.cs.

string Tamir.SharpSsh.SshShell.Expect ( )

Reads a response string from the SSH channel. This method will block until the pattern in the 'Prompt' property is matched in the response.

Returns:: A response string from the SSH server.

Definition at line 202 of file SshShell.cs.

Stream Tamir.SharpSsh.SshShell.GetStream ( )

Creates a new I/O stream of communication with this SSH shell connection.

Definition at line 135 of file SshShell.cs.

static string Tamir.SharpSsh.SshShell.HandleTerminalChars ( string str ) [static]

Removes escape sequence characters from the input string.

Definition at line 246 of file SshShell.cs.

void Tamir.SharpSsh.SshShell.Init ( ) [protected]

Definition at line 63 of file SshShell.cs.

override void Tamir.SharpSsh.SshShell.OnChannelReceived ( ) [protected, virtual]

Reimplemented from Tamir.SharpSsh.SshBase.

Definition at line 69 of file SshShell.cs.

void Tamir.SharpSsh.SshShell.RedirectToConsole ( )

Definition at line 151 of file SshShell.cs.

void Tamir.SharpSsh.SshShell.SetStream ( Stream s )

Definition at line 146 of file SshShell.cs.

void Tamir.SharpSsh.SshShell.SetStream	(	Stream	inputStream,
		Stream	outputStream
	)

Definition at line 140 of file SshShell.cs.

virtual void Tamir.SharpSsh.SshShell.Write	(	byte[]	buffer,
		int	offset,
		int	count
	)			`[virtual]`

Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Parameters:

	buffer	An array of bytes. This method copies count bytes from buffer to the current stream.
	offset	The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
	count	The number of bytes to be written to the current stream.

Definition at line 126 of file SshShell.cs.

virtual void Tamir.SharpSsh.SshShell.Write ( byte[] buffer ) [virtual]

Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.

Parameters:

buffer

An array of bytes. This method copies count bytes from buffer to the current stream.

Definition at line 114 of file SshShell.cs.

void Tamir.SharpSsh.SshShell.Write ( string data )

Definition at line 105 of file SshShell.cs.

void Tamir.SharpSsh.SshShell.WriteLine ( string data )

Definition at line 100 of file SshShell.cs.

Property Documentation

override string Tamir.SharpSsh.SshShell.ChannelType [get, protected]

Reimplemented from Tamir.SharpSsh.SshBase.

Definition at line 84 of file SshShell.cs.

string Tamir.SharpSsh.SshShell.ExpectPattern [get, set]

A regular expression pattern string to match when reading the resonse using the ReadResponse() method. The default prompt value is "\n" which makes the ReadRespons() method return one line of response.

Definition at line 193 of file SshShell.cs.

Stream Tamir.SharpSsh.SshShell.IO [get]

Definition at line 89 of file SshShell.cs.

bool Tamir.SharpSsh.SshShell.RemoveTerminalEmulationCharacters [get, set]

Gets or sets a value indicating wether this Steam sould remove the terminal emulation's escape sequence characters from the response String.

Definition at line 184 of file SshShell.cs.

virtual bool Tamir.SharpSsh.SshShell.ShellConnected [get]

Definition at line 169 of file SshShell.cs.

virtual bool Tamir.SharpSsh.SshShell.ShellOpened [get]

Definition at line 157 of file SshShell.cs.

The documentation for this class was generated from the following file:

C:/work/OMMR/OCHHP_OMMR_OMMR/Code/Assemblies/SharpSSH/Source/SharpSSH-1.1.1.13.src/SharpSSH/SshShell.cs


Public Member Functions
	SshShell (string host, string user, string password)
	SshShell (string host, string user)
void	WriteLine (string data)
void	Write (string data)
virtual void	Write (byte[] buffer)
	Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
virtual void	Write (byte[] buffer, int offset, int count)
	Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
Stream	GetStream ()
	Creates a new I/O stream of communication with this SSH shell connection.
void	SetStream (Stream inputStream, Stream outputStream)
void	SetStream (Stream s)
void	RedirectToConsole ()
string	Expect ()
	Reads a response string from the SSH channel. This method will block until the pattern in the 'Prompt' property is matched in the response.
string	Expect (string pattern)
	Reads a response string from the SSH channel. This method will block until the pattern in the 'Prompt' property is matched in the response.
string	Expect (Regex pattern)
	Reads a response string from the SSH channel. This method will block until the pattern in the 'Prompt' property is matched in the response.
Static Public Member Functions
static string	HandleTerminalChars (string str)
	Removes escape sequence characters from the input string.
Protected Member Functions
void	Init ()
override void	OnChannelReceived ()
Properties
override string	ChannelType `[get]`
Stream	IO `[get]`
virtual bool	ShellOpened `[get]`
virtual bool	ShellConnected `[get]`
bool	RemoveTerminalEmulationCharacters `[get, set]`
	Gets or sets a value indicating wether this Steam sould remove the terminal emulation's escape sequence characters from the response String.
string	ExpectPattern `[get, set]`
	A regular expression pattern string to match when reading the resonse using the ReadResponse() method. The default prompt value is "\n" which makes the ReadRespons() method return one line of response.