Click or drag to resize

ShellStream Class

Contains operation for working with SSH Shell.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharp.CrestronIOStream
    Crestron.SimplSharp.SshShellStream

Namespace: Crestron.SimplSharp.Ssh
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public class ShellStream : Stream

The ShellStream type exposes the following members.

Properties
 NameDescription
Public propertyCanRead Gets a value indicating whether the current stream supports reading.
(Overrides StreamCanRead)
Public propertyCanSeek Gets a value indicating whether the current stream supports seeking.
(Overrides StreamCanSeek)
Public propertyCanTimeout Gets a value that determines whether the current stream can time out.
(Inherited from Stream)
Public propertyCanWrite Gets a value indicating whether the current stream supports writing.
(Overrides StreamCanWrite)
Public propertyDataAvailable Gets a value that indicates whether data is available on the ShellStream to be read.
Public propertyLength Gets the length in bytes of the stream.
(Overrides StreamLength)
Public propertyPosition Gets or sets the position within the current stream.
(Overrides StreamPosition)
Public propertyReadTimeout Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream)
Public propertyWriteTimeout Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream)
Top
Methods
 NameDescription
Public methodBeginExpect(ExpectAction) Begins the expect.
Public methodBeginExpect(AsyncCallback, ExpectAction) Begins the expect.
Public methodBeginExpect(AsyncCallback, Object, ExpectAction) Begins the expect.
Public methodBeginExpect(TimeSpan, AsyncCallback, Object, ExpectAction) Begins the expect.
Public methodBeginRead Begins an asynchronous read operation.
(Inherited from Stream)
Public methodBeginWrite Begins an asynchronous write operation.
(Inherited from Stream)
Public methodClose Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
(Inherited from Stream)
Public methodDispose Releases all resources used by the Crestron.SimplSharp.CrestronStream.Stream.
(Inherited from Stream)
Protected methodDispose(Boolean) Releases the unmanaged resources used by the Stream and optionally releases the managed resources.
(Overrides StreamDispose(Boolean))
Public methodEndExpect Ends the execute.
Public methodEndRead Waits for the pending asynchronous read to complete.
(Inherited from Stream)
Public methodEndWrite Ends an asynchronous write operation.
(Inherited from Stream)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodExpect(ExpectAction) Expects the specified expression and performs action when one is found.
Public methodExpect(Regex) Expects the expression specified by regular expression.
Public methodExpect(String) Expects the expression specified by text.
Public methodExpect(Regex, TimeSpan) Expects the expression specified by regular expression.
Public methodExpect(String, TimeSpan) Expects the expression specified by text.
Public methodExpect(TimeSpan, ExpectAction) Expects the specified expression and performs action when one is found.
Protected methodFinalize Destructor for ShellStream.
(Overrides ObjectFinalize)
Public methodFlush Clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Overrides StreamFlush)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodRead Reads text available in the shell.
Public methodRead(Byte, Int32, Int32) Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
(Overrides StreamRead(Byte, Int32, Int32))
Public methodReadByte Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
(Inherited from Stream)
Public methodReadLine Reads the line from the shell. If line is not available it will block the execution and will wait for new line.
Public methodReadLine(TimeSpan) Reads the line from the shell. If line is not available it will block the execution and will wait for new line.
Public methodSeek This method is not supported.
(Overrides StreamSeek(Int64, SeekOrigin))
Public methodSetLength This method is not supported.
(Overrides StreamSetLength(Int64))
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Protected methodWaitHandle Waits for the handle to be signaled or for an error to occurs.
Public methodWrite(String) Writes the specified text to the shell.
Public methodWrite(Byte, Int32, Int32) Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
(Overrides StreamWrite(Byte, Int32, Int32))
Public methodWriteByte Writes a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from Stream)
Public methodWriteLine Writes the line to the shell.
Top
Events
 NameDescription
Public eventDataReceived Occurs when data was received.
Public eventErrorOccurred Occurs when an error occurred.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also