JuiceStream - Stream utilities for .NET
Stream is a very versatile abstraction. You can define all kinds of streams, layer streams upon streams,
and soon you discover reusable
that can be plugged in to handle specific behaviors or traits of the stream you are working with.
JuiceStream library attempts to include basic reusable
Binary communication protocols are probably the best place to use these classes.
Get JuiceStream from NuGet:
PM> Install-Package JuiceStream -Version 1.2.2
Or clone the source code. Sources and binaries are distributed under Apache License 2.0. Binaries are targeting .NET Standard 2.0.
After installing JuiceStream, you will gain access to the following Stream implementations:
.NET already has its
BufferedStream, but that one will
throw unexpected exceptions,
DuplexBufferedStream embeds two
BufferedStream instances, one for each direction,
to provide full duplex buffering over non-seekable streams.
As we have seen with HTTP, creating lots of parallel connections isn't healthy for performance of your application.
Just like HTTP 2.0, JuiceStream's
MultiplexStream allows you to tunnel multiple substreams through single outer stream.
Either peer can issue Connect calls that create substreams while the other peer issues Accept calls to get the opposite end of the substream.
Half-open TCP connections can cause serious sync issues in applications.
Default 2-hour TCP keepalive
cannot be configured on a per-connection basis on Windows.
Common wisdom is to implement application-layer ping.
PingStream will spare you of this duty.
Designed to work over single substream of the above mentioned
both endpoints of the
PingStream will perform regular pings in order to kill broken connections as early as possible.
Mostly intended for testing,
QueueStream is like
but it drops the inter-process functionality in favor of easy setup and higher performance.
QueueStream come out as reads from the same
DuplexQueueStream embeds two
to provide full-duplex in-memory communication between two linked
Many protocols need to include short "magic" headers that identify the protocol and its version.
PrefixStream encapsulates this behavior.
It writes out specified binary prefix before first write and checks presence and correctness of the prefix before first read.
When writing a lot of async code, one often discovers that all those
passed around are only used as parameters to
CancellableStream spares you of the possibility of forgetting to use the
by enforcing use of specified
CancellationToken in all calls to the controlled
Stream methods that take
the supplied token is in fact ignored and
NetworkStream keeps hanging on reads even after cancellation has been signaled.
ForceCancelStream is a wrapper around
NetworkStream (or any other
that enforces the use of
CancellationToken. It will return immediately after cancellation is signaled.
Stream will be left hanging in separate thread that will be cleaned up after you close the
which is the most likely scenario after you cancel an operation.
JuiceStream was developed by Robert Važan. If you have any suggestions, report an issue or submit a pull request via Bitbucket or GitHub. You can reach the author via email .