Class MonitoringStream

Namespace

Nerdbank.Streams

Assembly

Nerdbank.Streams.dll

A Stream that wraps another and reports all I/O taking place by raising events.

public class MonitoringStream : Stream, IAsyncDisposable, IDisposableObservable, IDisposable

Inheritance

object

MarshalByRefObject

Stream

MonitoringStream

Implements

IAsyncDisposable

IDisposableObservable

IDisposable

Inherited Members

Stream.Null

Stream.BeginRead(byte[], int, int, AsyncCallback, object)

Stream.BeginWrite(byte[], int, int, AsyncCallback, object)

Stream.Close()

Stream.CopyTo(Stream)

Stream.CopyTo(Stream, int)

Stream.CopyToAsync(Stream)

Stream.CopyToAsync(Stream, int)

Stream.CopyToAsync(Stream, int, CancellationToken)

Stream.CopyToAsync(Stream, CancellationToken)

Stream.CreateWaitHandle()

Stream.Dispose()

Stream.DisposeAsync()

Stream.EndRead(IAsyncResult)

Stream.EndWrite(IAsyncResult)

Stream.FlushAsync()

Stream.ObjectInvariant()

Stream.ReadAsync(byte[], int, int)

Stream.ReadAtLeast(Span<byte>, int, bool)

Stream.ReadAtLeastAsync(Memory<byte>, int, bool, CancellationToken)

Stream.ReadExactly(byte[], int, int)

Stream.ReadExactly(Span<byte>)

Stream.ReadExactlyAsync(byte[], int, int, CancellationToken)

Stream.ReadExactlyAsync(Memory<byte>, CancellationToken)

Stream.Synchronized(Stream)

Stream.ValidateBufferArguments(byte[], int, int)

Stream.ValidateCopyToArguments(Stream, int)

Stream.WriteAsync(byte[], int, int)

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.InitializeLifetimeService()

MarshalByRefObject.MemberwiseClone(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

PipeExtensions.UsePipe(Stream, bool, int, PipeOptions?, CancellationToken)

PipeExtensions.UsePipe(Stream, int, PipeOptions?, CancellationToken)

PipeExtensions.UsePipeReader(Stream, int, PipeOptions?, CancellationToken)

PipeExtensions.UsePipeWriter(Stream, PipeOptions?, CancellationToken)

PipeExtensions.UseStrictPipeReader(Stream, int)

PipeExtensions.UseStrictPipeWriter(Stream)

StreamExtensions.ReadBlockAsync(Stream, Memory<byte>, CancellationToken)

StreamExtensions.ReadBlockOrThrowAsync(Stream, Memory<byte>, CancellationToken)

StreamExtensions.ReadSlice(Stream, long)

StreamExtensions.ReadSubstream(Stream)

StreamExtensions.WriteSubstream(Stream, int)

Constructors

MonitoringStream(Stream)

Initializes a new instance of the MonitoringStream class.

public MonitoringStream(Stream inner)

Parameters

inner Stream

The stream to wrap and monitor I/O for.

Properties

CanRead

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

public override bool CanRead { get; }

Property Value

bool

true if the stream supports reading; otherwise, false.

CanSeek

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

public override bool CanSeek { get; }

Property Value

bool

true if the stream supports seeking; otherwise, false.

CanTimeout

Gets a value that determines whether the current stream can time out.

public override bool CanTimeout { get; }

Property Value

bool

A value that determines whether the current stream can time out.

CanWrite

When overridden in a derived class, gets a value indicating whether the current stream supports writing.

public override bool CanWrite { get; }

Property Value

bool

true if the stream supports writing; otherwise, false.

IsDisposed

Gets a value indicating whether this instance has been disposed.

public bool IsDisposed { get; }

Property Value

bool

true if this instance has been disposed.

Length

When overridden in a derived class, gets the length in bytes of the stream.

public override long Length { get; }

Property Value

long

A long value representing the length of the stream in bytes.

Exceptions

NotSupportedException

A class derived from Stream does not support seeking and the length is unknown.

ObjectDisposedException

Methods were called after the stream was closed.

Position

When overridden in a derived class, gets or sets the position within the current stream.

public override long Position { get; set; }

Property Value

long

The current position within the stream.

Exceptions

IOException

An I/O error occurs.

NotSupportedException

The stream does not support seeking.

ObjectDisposedException

Methods were called after the stream was closed.

ReadTimeout

Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.

public override int ReadTimeout { get; set; }

Property Value

int

A value, in milliseconds, that determines how long the stream will attempt to read before timing out.

Exceptions

InvalidOperationException

The ReadTimeout method always throws an InvalidOperationException.

WriteTimeout

Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.

public override int WriteTimeout { get; set; }

Property Value

int

A value, in milliseconds, that determines how long the stream will attempt to write before timing out.

Exceptions

InvalidOperationException

The WriteTimeout method always throws an InvalidOperationException.

Methods

Dispose(bool)

Releases the unmanaged resources used by the Stream and optionally releases the managed resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Flush()

When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.

public override void Flush()

Exceptions

IOException

An I/O error occurs.

FlushAsync(CancellationToken)

Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.

public override Task FlushAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A task that represents the asynchronous flush operation.

Exceptions

ObjectDisposedException

The stream has been disposed.

Read(byte[], int, int)

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.

public override int Read(byte[] buffer, int offset, int count)

Parameters

buffer byte[]

An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.

offset int

The zero-based byte offset in buffer at which to begin storing the data read from the current stream.

count int

The maximum number of bytes to be read from the current stream.

Returns

int

The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if count is 0 or the end of the stream has been reached.

Exceptions

ArgumentException

The sum of offset and count is larger than the buffer length.

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

IOException

An I/O error occurs.

NotSupportedException

The stream does not support reading.

ObjectDisposedException

Methods were called after the stream was closed.

Read(Span<byte>)

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.

public override int Read(Span<byte> buffer)

Parameters

buffer Span<byte>

A region of memory. When this method returns, the contents of this region are replaced by the bytes read from the current source.

Returns

int

The total number of bytes read into the buffer. This can be less than the size of the buffer if that many bytes are not currently available, or zero (0) if the buffer's length is zero or the end of the stream has been reached.

ReadAsync(byte[], int, int, 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.

public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)

Parameters

buffer byte[]

The buffer to write the data into.

offset int

The byte offset in buffer at which to begin writing data from the stream.

count int

The maximum number of bytes to read.

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task<int>

A task that represents the asynchronous read operation. The value of the TResult parameter contains the total number of bytes read into the buffer. The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if count is 0 or if the end of the stream has been reached.

Exceptions

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

ArgumentException

The sum of offset and count is larger than the buffer length.

NotSupportedException

The stream does not support reading.

ObjectDisposedException

The stream has been disposed.

InvalidOperationException

The stream is currently in use by a previous read operation.

ReadAsync(Memory<byte>, 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.

public override ValueTask<int> ReadAsync(Memory<byte> buffer, CancellationToken cancellationToken = default)

Parameters

buffer Memory<byte>

The region of memory to write the data into.

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

ValueTask<int>

A task that represents the asynchronous read operation. The value of its Result property contains the total number of bytes read into the buffer. The result value can be less than the length of the buffer if that many bytes are not currently available, or it can be 0 (zero) if the length of the buffer is 0 or if the end of the stream has been reached.

ReadByte()

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.

public override int ReadByte()

Returns

int

The unsigned byte cast to an int, or -1 if at the end of the stream.

Exceptions

NotSupportedException

The stream does not support reading.

ObjectDisposedException

Methods were called after the stream was closed.

Seek(long, SeekOrigin)

When overridden in a derived class, sets the position within the current stream.

public override long Seek(long offset, SeekOrigin origin)

Parameters

offset long

A byte offset relative to the origin parameter.

origin SeekOrigin

A value of type SeekOrigin indicating the reference point used to obtain the new position.

Returns

long

The new position within the current stream.

Exceptions

IOException

An I/O error occurs.

NotSupportedException

The stream does not support seeking, such as if the stream is constructed from a pipe or console output.

ObjectDisposedException

Methods were called after the stream was closed.

SetLength(long)

When overridden in a derived class, sets the length of the current stream.

public override void SetLength(long value)

Parameters

value long

The desired length of the current stream in bytes.

Exceptions

IOException

An I/O error occurs.

NotSupportedException

The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.

ObjectDisposedException

Methods were called after the stream was closed.

Write(byte[], int, int)

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.

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

Parameters

buffer byte[]

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

offset int

The zero-based byte offset in buffer at which to begin copying bytes to the current stream.

count int

The number of bytes to be written to the current stream.

Exceptions

ArgumentException

The sum of offset and count is greater than the buffer length.

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

IOException

An I/O error occurred, such as the specified file cannot be found.

NotSupportedException

The stream does not support writing.

ObjectDisposedException

Write(byte[], int, int) was called after the stream was closed.

Write(ReadOnlySpan<byte>)

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.

public override void Write(ReadOnlySpan<byte> buffer)

Parameters

buffer ReadOnlySpan<byte>

A region of memory. This method copies the contents of this region to the current stream.

WriteAsync(byte[], int, int, 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.

public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)

Parameters

buffer byte[]

The buffer to write data from.

offset int

The zero-based byte offset in buffer from which to begin copying bytes to the stream.

count int

The maximum number of bytes to write.

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

Task

A task that represents the asynchronous write operation.

Exceptions

ArgumentNullException

buffer is null.

ArgumentOutOfRangeException

offset or count is negative.

ArgumentException

The sum of offset and count is larger than the buffer length.

NotSupportedException

The stream does not support writing.

ObjectDisposedException

The stream has been disposed.

InvalidOperationException

The stream is currently in use by a previous write operation.

WriteAsync(ReadOnlyMemory<byte>, 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.

public override ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, CancellationToken cancellationToken = default)

Parameters

buffer ReadOnlyMemory<byte>

The region of memory to write data from.

cancellationToken CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

ValueTask

A task that represents the asynchronous write operation.

WriteByte(byte)

Writes a byte to the current position in the stream and advances the position within the stream by one byte.

public override void WriteByte(byte value)

Parameters

value byte

The byte to write to the stream.

Exceptions

IOException

An I/O error occurs.

NotSupportedException

The stream does not support writing, or the stream is already closed.

ObjectDisposedException

Methods were called after the stream was closed.

Events

DidFlush

Occurs after Flush() or FlushAsync(CancellationToken) is invoked.

public event EventHandler? DidFlush

Event Type

EventHandler

DidRead

Occurs after Read(byte[], int, int) or ReadAsync(byte[], int, int, CancellationToken) is invoked.

public event EventHandler<ArraySegment<byte>>? DidRead

Event Type

EventHandler<ArraySegment<byte>>

Remarks

The Count value is the actual bytes that were read.

DidReadByte

Occurs after ReadByte() is invoked.

public event EventHandler<int>? DidReadByte

Event Type

EventHandler<int>

DidReadMemory

Occurs after ReadAsync(Memory<byte>, CancellationToken) is invoked.

public event EventHandler<Memory<byte>>? DidReadMemory

Event Type

EventHandler<Memory<byte>>

DidReadSpan

Occurs after Read(Span<byte>) is invoked.

public event MonitoringStream.SpanEventHandler? DidReadSpan

Event Type

MonitoringStream.SpanEventHandler

DidSeek

Occurs after Seek(long, SeekOrigin) is invoked.

public event EventHandler<long>? DidSeek

Event Type

EventHandler<long>

DidSetLength

Occurs after SetLength(long) is invoked.

public event EventHandler<long>? DidSetLength

Event Type

EventHandler<long>

DidWrite

Occurs after Write(byte[], int, int) or WriteAsync(byte[], int, int, CancellationToken) is invoked.

public event EventHandler<ArraySegment<byte>>? DidWrite

Event Type

EventHandler<ArraySegment<byte>>

DidWriteByte

Occurs after WriteByte(byte) is invoked.

public event EventHandler<byte>? DidWriteByte

Event Type

EventHandler<byte>

DidWriteMemory

Occurs after WriteAsync(ReadOnlyMemory<byte>, CancellationToken) is invoked.

public event EventHandler<ReadOnlyMemory<byte>>? DidWriteMemory

Event Type

EventHandler<ReadOnlyMemory<byte>>

DidWriteSpan

Occurs after Write(ReadOnlySpan<byte>) is invoked.

public event MonitoringStream.ReadOnlySpanEventHandler? DidWriteSpan

Event Type

MonitoringStream.ReadOnlySpanEventHandler

Disposed

Occurs when Dispose() is invoked.

public event EventHandler? Disposed

Event Type

EventHandler

EndOfStream

Occurs the first time a read method returns 0 bytes.

public event EventHandler? EndOfStream

Event Type

EventHandler

WillRead

Occurs before Read(byte[], int, int) or ReadAsync(byte[], int, int, CancellationToken) is invoked.

public event EventHandler<ArraySegment<byte>>? WillRead

Event Type

EventHandler<ArraySegment<byte>>

Remarks

The Count value is the maximum bytes that may be read.

WillReadByte

Occurs before ReadByte() is invoked.

public event EventHandler? WillReadByte

Event Type

EventHandler

WillReadMemory

Occurs before ReadAsync(Memory<byte>, CancellationToken) is invoked.

public event EventHandler<Memory<byte>>? WillReadMemory

Event Type

EventHandler<Memory<byte>>

Remarks

The Length value is the maximum bytes that may be read.

WillReadSpan

Occurs before Read(Span<byte>) is invoked.

public event MonitoringStream.SpanEventHandler? WillReadSpan

Event Type

MonitoringStream.SpanEventHandler

WillSetLength

Occurs before SetLength(long) is invoked.

public event EventHandler<long>? WillSetLength

Event Type

EventHandler<long>

WillWrite

Occurs before Write(byte[], int, int) or WriteAsync(byte[], int, int, CancellationToken) is invoked.

public event EventHandler<ArraySegment<byte>>? WillWrite

Event Type

EventHandler<ArraySegment<byte>>

WillWriteByte

Occurs before WriteByte(byte) is invoked.

public event EventHandler<byte>? WillWriteByte

Event Type

EventHandler<byte>

WillWriteMemory

Occurs before WriteAsync(ReadOnlyMemory<byte>, CancellationToken) is invoked.

public event EventHandler<ReadOnlyMemory<byte>>? WillWriteMemory

Event Type

EventHandler<ReadOnlyMemory<byte>>

WillWriteSpan

Occurs before Write(ReadOnlySpan<byte>) is invoked.

public event MonitoringStream.ReadOnlySpanEventHandler? WillWriteSpan

Event Type

MonitoringStream.ReadOnlySpanEventHandler