https://github.com/AArnott/Nerdbank.Streams

Specialized .NET Streams and pipes for full duplex in-proc communication, web sockets, and multiplexing
https://github.com/AArnott/Nerdbank.Streams

Last synced: about 1 month ago
JSON representation

Specialized .NET Streams and pipes for full duplex in-proc communication, web sockets, and multiplexing

• Host: GitHub
• URL: https://github.com/AArnott/Nerdbank.Streams
• Owner: dotnet
• License: mit
• Created: 2015-10-07T04:48:20.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-08-01T05:23:32.000Z (about 2 months ago)
• Last Synced: 2024-08-07T16:04:17.903Z (about 1 month ago)
• Language: C#
• Homepage:
• Size: 3.62 MB
• Stars: 596
• Watchers: 15
• Forks: 57
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE-OF-CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Specialized .NET Stream classes

[![NuGet package](https://img.shields.io/nuget/v/Nerdbank.Streams.svg)](https://nuget.org/packages/Nerdbank.Streams)

[![Build Status](https://dev.azure.com/andrewarnott/OSS/_apis/build/status/Nerdbank.Streams)](https://dev.azure.com/andrewarnott/OSS/_build/latest?definitionId=14)

[![codecov](https://codecov.io/gh/AArnott/Nerdbank.Streams/branch/main/graph/badge.svg)](https://codecov.io/gh/AArnott/Nerdbank.Streams)

*Enhanced streams for communication in-proc or across the Internet.*

## Features

1. [`SimplexStream`](doc/SimplexStream.md) is meant to allow two parties to communicate *one direction*.

   Anything written to the stream can subsequently be read from it. You can share this `Stream`

   with any two parties (in the same AppDomain) and one can send messages to the other.

1. [`FullDuplexStream`](doc/FullDuplexStream.md) creates a pair of bidirectional streams for

   in-proc two-way communication; it also creates a single bidirectional stream from two

   unidirectional streams.

1. [`MultiplexingStream`](doc/MultiplexingStream.md) 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.

1. [`AsStream()`](doc/AsStream.md) wraps a `WebSocket`, `System.IO.Pipelines.PipeReader`,

   `System.IO.Pipelines.PipeWriter`, or `System.IO.Pipelines.IDuplexPipe` with a

   `System.IO.Stream` for reading and/or writing.

1. [`UsePipe()`](doc/UsePipe.md) enables reading from

   and writing to a `Stream` or `WebSocket` using the `PipeReader` and `PipeWriter` APIs.

1. [`Stream.ReadSlice(long)`](doc/ReadSlice.md) creates a sub-stream that ends after

   a given number of bytes.

1. [`PipeReader.ReadSlice(long)`](doc/ReadSlice.md) creates a sub-`PipeReader` that ends after

   a given number of bytes.

1. [`MonitoringStream`](doc/MonitoringStream.md) wraps another Stream and raises events for

   all I/O calls so you can monitor and/or trace the data as it goes by.

1. [`WriteSubstream` and `ReadSubstream`](doc/Substream.md) 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.

1. [`Sequence`](doc/Sequence.md) is a builder for `ReadOnlySequence`.

1. [`PrefixingBufferWriter`](doc/PrefixingBufferWriter.md) wraps another `IBufferWriter`

   to allow for prefixing some header to the next written buffer, which may be arbitrarily long.

1. [`BufferTextWriter`](doc/BufferTextWriter.md) is a `TextWriter`-derived type that can

   write directly to any `IBufferWriter`, making it more reusable than `StreamWriter`

   and thus allows for alloc-free writing across many writers.

1. [`SequenceTextReader`](doc/SequenceTextReader.md) is a `TextReader`-derived type that can

   read directly from any `ReadOnlySequence`, making it more reusable than `StreamReader`

   and thus allows for alloc-free reading across many sequences.

1. [`DuplexPipe`](doc/DuplexPipe.md) is a trivial implementation of `IDuplexPipe`.

1. [`Stream.ReadBlockAsync`](doc/ReadBlockAsync.md) guarantees to fill the supplied buffer except under certain documented conditions, instead of the regular `ReadAsync` guarantee of supplying at least 1 byte.

## .NET Foundation

This project is supported by the [.NET Foundation](https://dotnetfoundation.org).