Class ByteStreamReader

Reader for an incoming byte data stream.

public sealed class ByteStreamReader

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

public ByteStreamInfo Info { get; }

Reads all incoming chunks from the stream, concatenating them into a single value once the stream closes normally.

public ByteStreamReader.ReadAllInstruction ReadAll()

ByteStreamReader.ReadAllInstruction: A ByteStreamReader.ReadAllInstruction that completes when the stream is complete or errors. Check ReadAllInstruction.IsError and access Bytes properties to handle the result.

Calling this method consumes the stream reader.

Reads incoming chunks from the stream incrementally.

public ByteStreamReader.ReadIncrementalInstruction ReadIncremental()

ByteStreamReader.ReadIncrementalInstruction: A ByteStreamReader.ReadIncrementalInstruction that allows reading the stream incrementally.

Reads incoming chunks from the byte stream, writing them to a file as they are received.

public ByteStreamReader.WriteToFileInstruction WriteToFile(string directory = null, string nameOverride = null)

directory string: The directory to write the file in. The system temporary directory is used if not specified.
nameOverride string: The name to use for the written file, overriding stream name.

ByteStreamReader.WriteToFileInstruction: A ByteStreamReader.WriteToFileInstruction that completes when the stream is complete or errors. Check WriteToFileInstruction.IsError and access FilePath properties to handle the result.

Calling this method consumes the stream reader.