Click or drag to resize

RelayStream Class

Implements a stream that passes operations to another stream. This is mainly useful for controlling whether Dispose and Dispose(Boolean) actually disposes the underlying stream or not when the stream is referenced by another class that always disposes the stream.
Inheritance Hierarchy

Namespace:  Neon.IO
Assembly:  Neon.Common (in Neon.Common.dll) Version: 2.4.1
Syntax
public class RelayStream : Stream

The RelayStream type exposes the following members.

Constructors
  NameDescription
Public methodRelayStream
Constructor.
Top
Properties
  NameDescription
Public propertyCanRead
When overridden in a derived class, gets a value indicating whether the current stream supports reading.
(Overrides StreamCanRead.)
Public propertyCanSeek
When overridden in a derived class, 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
When overridden in a derived class, gets a value indicating whether the current stream supports writing.
(Overrides StreamCanWrite.)
Public propertyLength
When overridden in a derived class, gets the length in bytes of the stream.
(Overrides StreamLength.)
Public propertyPosition
When overridden in a derived class, gets or sets the position within the current stream.
(Overrides StreamPosition.)
Public propertyReadTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to read before timing out.
(Inherited from Stream.)
Public propertyWriteTimeout
Gets or sets a value, in miliseconds, that determines how long the stream will attempt to write before timing out.
(Inherited from Stream.)
Top
Methods
  NameDescription
Public methodBeginRead (Inherited from Stream.)
Public methodBeginWrite (Inherited from Stream.)
Public methodClose
Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed.
(Inherited from Stream.)
Public methodCopyTo(Stream)
Reads the bytes from the current stream and writes them to another stream.
(Inherited from Stream.)
Public methodCopyTo(Stream, Int32)
Reads the bytes from the current stream and writes them to another stream, using a specified buffer size.
(Inherited from Stream.)
Public methodCopyToAsync(Stream)
Asynchronously reads the bytes from the current stream and writes them to another stream.
(Inherited from Stream.)
Public methodCopyToAsync(Stream, Int32)
Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size.
(Inherited from Stream.)
Public methodCopyToAsync(Stream, Int32, CancellationToken)
Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token.
(Inherited from Stream.)
Protected methodCreateWaitHandle Obsolete.
Allocates a WaitHandle object.
(Inherited from Stream.)
Public methodDispose
Releases all resources used by the 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 methodEndRead (Inherited from Stream.)
Public methodEndWrite (Inherited from Stream.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
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 StreamFlush.)
Public methodFlushAsync
Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device.
(Inherited from Stream.)
Public methodFlushAsync(CancellationToken)
Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.
(Inherited from Stream.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Protected methodObjectInvariant Obsolete.
Provides support for a Contract.
(Inherited from Stream.)
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 StreamRead(Byte, Int32, Int32).)
Public methodReadAsync(Byte, Int32, Int32)
Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
(Inherited from Stream.)
Public methodReadAsync(Byte, Int32, Int32, CancellationToken)
Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests.
(Inherited from Stream.)
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 methodSeek
When overridden in a derived class, sets the position within the current stream.
(Overrides StreamSeek(Int64, SeekOrigin).)
Public methodSetLength
When overridden in a derived class, sets the length of the current stream.
(Overrides StreamSetLength(Int64).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
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 StreamWrite(Byte, Int32, Int32).)
Public methodWriteAsync(Byte, Int32, Int32)
Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
(Inherited from Stream.)
Public methodWriteAsync(Byte, Int32, Int32, CancellationToken)
Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests.
(Inherited from Stream.)
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.)
Top
Extension Methods
  NameDescription
Public Extension MethodDeflateTo
Uses deflate to compress a source to a target stream.
(Defined by IOExtensions.)
Public Extension MethodGunzipTo
Uses GZIP to decompress a source to a target stream.
(Defined by IOExtensions.)
Public Extension MethodGzipTo
Uses GZIP to compress a source to a target stream.
(Defined by IOExtensions.)
Public Extension MethodInflateTo
Uses deflate to decompress a source to a target stream.
(Defined by IOExtensions.)
Public Extension MethodReadBytes
Reads the byte array from the current position, advancing the position past the value read.
(Defined by IOExtensions.)
Public Extension MethodReadToEnd
Reads all bytes from the current position to the end of the stream.
(Defined by IOExtensions.)
Public Extension MethodReadToEndAsync
Asynchronously reads all bytes from the current position to the end of the stream.
(Defined by IOExtensions.)
Public Extension MethodWrite
Writes a byte array to a stream.
(Defined by IOExtensions.)
Public Extension MethodWriteAsync
Asynchronously writes a byte array to a stream.
(Defined by IOExtensions.)
Top
See Also