The streams in this package focus on communication (not persistence).
HalfDuplexStream
is meant to allow two parties to communicate one direction. Anything written to the stream can subsequently be read from it. You can share thisStream
with any two parties (in the same AppDomain) and one can send messages to the other.FullDuplexStream
provides twoStream
objects, which you assign out to each of two parties. These parties can now send and receive messages with each other by reading from and writing to their assignedStream
instance.MultiplexingStream
allows you to split any bidirectional .NET Stream into many sub-streams (called channels). This allows two parties to establish just one transport stream (e.g. named pipe or web socket) and use it for many independent protocols. For example, one might set up JSON-RPC on one channel and use other channels for efficient binary transfers.AsStream()
wraps aWebSocket
,System.IO.Pipelines.PipeReader
,System.IO.Pipelines.PipeWriter
, orSystem.IO.Pipelines.IDuplexPipe
with aSystem.IO.Stream
for reading and/or writing.UsePipe()
enables reading from and writing to aStream
orWebSocket
using thePipeReader
andPipeWriter
APIs.Stream.ReadSlice(int)
creates a sub-stream that ends after a given number of bytes.MonitoringStream
wraps another Stream and raises events for all I/O calls so you can monitor and/or trace the data as it goes by.WriteSubstream
andReadSubstream
allow you to serialize data of an unknown length as part of a larger stream, and later deserialize it such in reading the substream, you cannot read more bytes than were written to it.Sequence<T>
is a builder forReadOnlySequence<T>
.