Class ProgressStream

Wraps another stream and provides reporting for when bytes are read or written to the stream.

Inheritance

System.Object

System.MarshalByRefObject

System.IO.Stream

ProgressStream

Implements

System.IDisposable

Inherited Members

System.IO.Stream.Null

System.IO.Stream.CopyToAsync(System.IO.Stream)

System.IO.Stream.CopyToAsync(System.IO.Stream, System.Int32)

System.IO.Stream.CopyToAsync(System.IO.Stream, System.Int32, System.Threading.CancellationToken)

System.IO.Stream.CopyTo(System.IO.Stream)

System.IO.Stream.CopyTo(System.IO.Stream, System.Int32)

System.IO.Stream.Dispose()

System.IO.Stream.Dispose(System.Boolean)

System.IO.Stream.FlushAsync()

System.IO.Stream.FlushAsync(System.Threading.CancellationToken)

System.IO.Stream.CreateWaitHandle()

System.IO.Stream.BeginRead(System.Byte[], System.Int32, System.Int32, System.AsyncCallback, System.Object)

System.IO.Stream.EndRead(System.IAsyncResult)

System.IO.Stream.ReadAsync(System.Byte[], System.Int32, System.Int32)

System.IO.Stream.ReadAsync(System.Byte[], System.Int32, System.Int32, System.Threading.CancellationToken)

System.IO.Stream.BeginWrite(System.Byte[], System.Int32, System.Int32, System.AsyncCallback, System.Object)

System.IO.Stream.EndWrite(System.IAsyncResult)

System.IO.Stream.WriteAsync(System.Byte[], System.Int32, System.Int32)

System.IO.Stream.WriteAsync(System.Byte[], System.Int32, System.Int32, System.Threading.CancellationToken)

System.IO.Stream.ReadByte()

System.IO.Stream.WriteByte(System.Byte)

System.IO.Stream.Synchronized(System.IO.Stream)

System.IO.Stream.ObjectInvariant()

System.IO.Stream.CanTimeout

System.IO.Stream.ReadTimeout

System.IO.Stream.WriteTimeout

System.MarshalByRefObject.MemberwiseClone(System.Boolean)

System.MarshalByRefObject.GetLifetimeService()

System.MarshalByRefObject.InitializeLifetimeService()

System.MarshalByRefObject.CreateObjRef(System.Type)

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Dapplo.HttpExtensions.Support

Assembly: Dapplo.HttpExtensions.dll

Syntax

public class ProgressStream : Stream, IDisposable

Constructors

ProgressStream(Stream)

Creates a new ProgressStream supplying the stream for it to report on.

Declaration

public ProgressStream(Stream streamToReportOn)

Parameters

Type	Name	Description
System.IO.Stream	streamToReportOn	The underlying stream that will be reported on when bytes are read or written.

Properties

BytesMoved

RaisedCalled when bytes are either read or written to the stream.

Declaration

public Action<object, ProgressStreamReport> BytesMoved { get; set; }

Property Value

Type	Description
Action<System.Object, ProgressStreamReport>

BytesRead

Called when bytes are read from the stream.

Declaration

public Action<object, ProgressStreamReport> BytesRead { get; set; }

Property Value

Type	Description
Action<System.Object, ProgressStreamReport>

BytesWritten

RaisedCalled when bytes are written to the stream.

Declaration

public Action<object, ProgressStreamReport> BytesWritten { get; set; }

Property Value

Type	Description
Action<System.Object, ProgressStreamReport>

CanRead

Declaration

public override bool CanRead { get; }

Property Value

Type	Description
System.Boolean

Overrides

System.IO.Stream.CanRead

CanSeek

Declaration

public override bool CanSeek { get; }

Property Value

Type	Description
System.Boolean

Overrides

System.IO.Stream.CanSeek

CanWrite

Declaration

public override bool CanWrite { get; }

Property Value

Type	Description
System.Boolean

Overrides

System.IO.Stream.CanWrite

Length

Declaration

public override long Length { get; }

Property Value

Type	Description
System.Int64

Overrides

System.IO.Stream.Length

Position

Declaration

public override long Position { get; set; }

Property Value

Type	Description
System.Int64

Overrides

System.IO.Stream.Position

Methods

Close()

Declaration

public override void Close()

Overrides

System.IO.Stream.Close()

Flush()

Declaration

public override void Flush()

Overrides

System.IO.Stream.Flush()

OnBytesMoved(Int32, Boolean)

Called when bytes are moved

Declaration

protected virtual void OnBytesMoved(int bytesMoved, bool isRead)

Parameters

Type	Name	Description
System.Int32	bytesMoved	int with the number of bytes which are moved
System.Boolean	isRead	true if the bytes were read, false if written

OnBytesRead(Int32)

Called when bytes are read.

Declaration

protected virtual void OnBytesRead(int bytesMoved)

Parameters

Type	Name	Description
System.Int32	bytesMoved	int with the number of bytes

OnBytesWritten(Int32)

Called when bytes are written

Declaration

protected virtual void OnBytesWritten(int bytesMoved)

Parameters

Type	Name	Description
System.Int32	bytesMoved	int with the number of bytes

Read(Byte[], Int32, Int32)

Declaration

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

Parameters

Type	Name	Description
System.Byte[]	buffer
System.Int32	offset
System.Int32	count

Returns

Type	Description
System.Int32

Overrides

System.IO.Stream.Read(System.Byte[], System.Int32, System.Int32)

Seek(Int64, SeekOrigin)

Declaration

public override long Seek(long offset, SeekOrigin origin)

Parameters

Type	Name	Description
System.Int64	offset
System.IO.SeekOrigin	origin

Returns

Type	Description
System.Int64

Overrides

System.IO.Stream.Seek(System.Int64, System.IO.SeekOrigin)

SetLength(Int64)

Declaration

public override void SetLength(long value)

Parameters

Type	Name	Description
System.Int64	value

Overrides

System.IO.Stream.SetLength(System.Int64)

Write(Byte[], Int32, Int32)

Declaration

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

Parameters

Type	Name	Description
System.Byte[]	buffer
System.Int32	offset
System.Int32	count

Overrides

System.IO.Stream.Write(System.Byte[], System.Int32, System.Int32)

Implements

System.IDisposable