PipeStream MembersSSH .NET Client Library Documentation

The PipeStream type exposes the following members.
Constructors

  NameDescription
Public methodPipeStream
Initializes a new instance of the PipeStream class
Back to Top
Methods

  NameDescription
Public methodOnlineBeginRead
Begins an asynchronous read operation.
(Inherited from OnlineStream.)
Public methodOnlineBeginWrite
Begins an asynchronous write operation.
(Inherited from OnlineStream.)
Public methodOnlineClose
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
(Inherited from OnlineStream.)
Public methodOnlineCopyTo(Stream)
Reads all the bytes from the current stream and writes them to the destination stream.
(Inherited from OnlineStream.)
Public methodOnlineCopyTo(Stream, Int32)
Reads all the bytes from the current stream and writes them to a destination stream, using a specified buffer size.
(Inherited from OnlineStream.)
Public methodOnlineCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from OnlineMarshalByRefObject.)
Protected methodOnlineCreateWaitHandleObsolete.
Allocates a OnlineWaitHandle object.
(Inherited from OnlineStream.)
Public methodOnlineDispose 
Releases all resources used by the OnlineStream.
(Inherited from OnlineStream.)
Protected methodOnlineDispose(Boolean)
Releases the unmanaged resources used by the OnlineStream and optionally releases the managed resources.
(Inherited from OnlineStream.)
Public methodOnlineEndRead
Waits for the pending asynchronous read to complete.
(Inherited from OnlineStream.)
Public methodOnlineEndWrite
Ends an asynchronous write operation.
(Inherited from OnlineStream.)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an OnlineObject to attempt to free resources and perform other cleanup operations before the OnlineObject is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodFlush
When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Overrides OnlineStream Flush .)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from OnlineMarshalByRefObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodOnlineInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from OnlineMarshalByRefObject.)
Protected methodOnlineMemberwiseClone 
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineMemberwiseClone(Boolean)
Creates a shallow copy of the current OnlineMarshalByRefObject object.
(Inherited from OnlineMarshalByRefObject.)
Protected methodOnlineObjectInvariant
Provides support for a OnlineContract.
(Inherited from OnlineStream.)
Public methodRead
When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
(Overrides OnlineStream Read( Byte , Int32, Int32).)
Public methodOnlineReadByte
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 OnlineStream.)
Public methodSeek
When overridden in a derived class, sets the position within the current stream.
(Overrides OnlineStream Seek(Int64, SeekOrigin).)
Public methodSetLength
When overridden in a derived class, sets the length of the current stream.
(Overrides OnlineStream SetLength(Int64).)
Public methodOnlineToString
Returns a OnlineString that represents the current OnlineObject.
(Inherited from OnlineObject.)
Public methodWrite
When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
(Overrides OnlineStream Write( Byte , Int32, Int32).)
Public methodOnlineWriteByte
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
(Inherited from OnlineStream.)
Back to Top
Properties

  NameDescription
Public propertyBlockLastReadBuffer
Gets or sets a value indicating whether to block last read method before the buffer is empty. When true, Read() will block until it can fill the passed in buffer and count. When false, Read() will not block, returning all the available buffer data.
Public propertyCanRead
When overridden in a derived class, gets a value indicating whether the current stream supports reading.
(Overrides OnlineStream CanRead.)
Public propertyCanSeek
When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
(Overrides OnlineStream CanSeek.)
Public propertyOnlineCanTimeout
Gets a value that determines whether the current stream can time out.
(Inherited from OnlineStream.)
Public propertyCanWrite
When overridden in a derived class, gets a value indicating whether the current stream supports writing.
(Overrides OnlineStream CanWrite.)
Public propertyLength
When overridden in a derived class, gets the length in bytes of the stream.
(Overrides OnlineStream Length.)
Public propertyMaxBufferLength
Gets or sets the maximum number of bytes to store in the buffer.
Public propertyPosition
When overridden in a derived class, gets or sets the position within the current stream.
(Overrides OnlineStream Position.)
Public propertyOnlineReadTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from OnlineStream.)
Public propertyOnlineWriteTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from OnlineStream.)
Back to Top
See Also