H.Formatters.BinaryFormatter 2.0.38

.NET Standard 2.0 .NET Framework 4.5.1
Install-Package H.Formatters.BinaryFormatter -Version 2.0.38
dotnet add package H.Formatters.BinaryFormatter --version 2.0.38
<PackageReference Include="H.Formatters.BinaryFormatter" Version="2.0.38" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add H.Formatters.BinaryFormatter --version 2.0.38
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: H.Formatters.BinaryFormatter, 2.0.38"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install H.Formatters.BinaryFormatter as a Cake Addin
#addin nuget:?package=H.Formatters.BinaryFormatter&version=2.0.38

// Install H.Formatters.BinaryFormatter as a Cake Tool
#tool nuget:?package=H.Formatters.BinaryFormatter&version=2.0.38
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Async Named Pipe Wrapper for .NET Standard 2.0

Language License Requirements Build Status

A simple, easy to use, strongly-typed, async wrapper around .NET named pipes.

Features

  • Create named pipe servers that can handle multiple client connections simultaneously.
  • Send strongly-typed messages between clients and servers: any serializable .NET object can be sent over a pipe and will be automatically serialized/deserialized, including cyclical references and complex object graphs.
  • Async
  • Requires .NET Standard 2.0
  • Supports large messages - up to 300 MiB.
  • Server restart automatically
  • Automatically wait for the release of the pipe for the server, if it is already in use
  • Automatically waiting for a server pipe creating when client connecting
  • Automatic reconnect with a given interval and at each client.WriteAsync, if necessary
  • Supports variable formatters, default - BinaryFormatter which uses System.Runtime.Serialization.BinaryFormatter inside
  • Also available ready formatters in separate nuget packages: H.Formatters.Newtonsoft.Json, H.Formatters.System.Text.Json and H.Formatters.Ceras
  • Supports PipeAccessRule's(see H.Pipes.AccessControl nuget package) or more complex code to access using the PipeServer.PipeStreamInitializeAction property

Nuget

NuGet NuGet NuGet NuGet NuGet

// All clients and servers that do not need support AccessControl.
Install-Package H.Pipes

// Servers that need support AccessControl.
Install-Package H.Pipes.AccessControl

// If you want to transfer any data that can be serialized/deserialized in json using Newtonsoft.Json.
Install-Package H.Formatters.Newtonsoft.Json

// If you want to transfer any data that can be serialized/deserialized in json using System.Text.Json.
Install-Package H.Formatters.System.Text.Json

// If you want to transfer any data that can be serialized/deserialized in binary using Ceras.
Install-Package H.Formatters.Ceras

Usage

Server:

await using var server = new PipeServer<MyMessage>(pipeName);
server.ClientConnected += async (o, args) =>
{
    Console.WriteLine($"Client {args.Connection.PipeName} is now connected!");

    await args.Connection.WriteAsync(new MyMessage
    {
        Text = "Welcome!"
    });
};
server.ClientDisconnected += (o, args) =>
{
    Console.WriteLine($"Client {args.Connection.PipeName} disconnected");
};
server.MessageReceived += (sender, args) =>
{
    Console.WriteLine($"Client {args.Connection.PipeName} says: {args.Message}");
};
server.ExceptionOccurred += (o, args) => OnExceptionOccurred(args.Exception);

await server.StartAsync();

await Task.Delay(Timeout.InfiniteTimeSpan);

Client:

await using var client = new PipeClient<MyMessage>(pipeName);
client.MessageReceived += (o, args) => Console.WriteLine("MessageReceived: " + args.Message);
client.Disconnected += (o, args) => Console.WriteLine("Disconnected from server");
client.Connected += (o, args) => Console.WriteLine("Connected to server");
client.ExceptionOccurred += (o, args) => OnExceptionOccurred(args.Exception);

await client.ConnectAsync();

await client.WriteAsync(new MyMessage
{
    Text = "Hello!",
});

await Task.Delay(Timeout.InfiniteTimeSpan);

Notes:

  • To use the server inside the WinForms/WPF/Other UI application, use Task.Run() or any alternative.
  • Be careful and call Dispose before closing the program/after the end of use. Pipes are system resources and you might have problems restarting the server if you don't properly clean up the resources.

Custom Formatters

Since BinaryFormatter is used by default, you should check out this article: https://docs.microsoft.com/en-us/dotnet/standard/serialization/binaryformatter-security-guide

Install-Package H.Formatters.Newtonsoft.Json
Install-Package H.Formatters.System.Text.Json
Install-Package H.Formatters.Ceras
using H.Formatters;

await using var server = new PipeServer<MyMessage>(pipeName, formatter: new NewtonsoftJsonFormatter());
await using var client = new PipeClient<MyMessage>(pipeName, formatter: new NewtonsoftJsonFormatter());

Access Control

⚠️ Note: this is only available for the Windows platform

Install-Package H.Pipes.AccessControl
using System.IO.Pipes;
using H.Pipes.AccessControl;

await using var server = new PipeServer<string>(pipeName);

// You can set PipeSecurity
var pipeSecurity = new PipeSecurity();
pipeSecurity.AddAccessRule(new PipeAccessRule(new SecurityIdentifier(WellKnownSidType.BuiltinUsersSid, null), PipeAccessRights.ReadWrite, AccessControlType.Allow));

server.SetPipeSecurity(pipeSecurity);

// or just add AccessRule's (Please be careful, the server will only consider AccessRules from the last call AddAccessRules())
server.AddAccessRules(new PipeAccessRule(new SecurityIdentifier(WellKnownSidType.BuiltinUsersSid, null), PipeAccessRights.ReadWrite, AccessControlType.Allow));

// or just
server.AllowUsersReadWrite();

Encryption

⚠️ Note: this is only available for the Windows platform

Install-Package H.Formatters.Inferno
using H.Formatters;

await using var server = new PipeServer<MyMessage>(pipeName, formatter: new SystemTextJsonFormatter());
server.EnableEncryption();

await using var client = new PipeClient<MyMessage>(pipeName, formatter: new SystemTextJsonFormatter());
client.EnableEncryption();

await client.ConnectAsync(source.Token).ConfigureAwait(false);
// Waits for key exchange.
await client.Connection!.WaitExchangeAsync();

server.ClientConnected += async (_, args) =>
{
    // Waits for key exchange.
    await args.Connection.WaitExchangeAsync();

    await args.Connection.WriteAsync(new MyMessage
    {
        Text = "Welcome!"
    }, source.Token).ConfigureAwait(false);
};

GetImpersonationUserName

server.ClientConnected += async (o, args) =>
{
    var name = args.Connection.GetImpersonationUserName();

    Console.WriteLine($"Client {name} is now connected!");
};

Inter-process communication

I recommend that you take a look at my other library if you plan on doing IPC. This is a SourceGenerator that will generate client and server code based on the presented interface.

Contacts

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net451 net452 net46 net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on H.Formatters.BinaryFormatter:

Package Downloads
H.Pipes

Features: - Create named pipe servers that can handle multiple client connections simultaneously. - Send strongly-typed messages between clients and servers: any serializable .NET object can be sent over a pipe and will be automatically serialized/deserialized, including cyclical references and complex object graphs. - Async - Requires .NET Standard 2.0 - Supports large messages - up to 300 MiB. - Server restart automatically - Automatically wait for the release of the pipe for the server, if it is already in use - Automatically waiting for a server pipe creating when client connecting - Automatic reconnect with a given interval and at each `client.WriteAsync`, if necessary - Supports variable formatters, default - BinaryFormatter which uses System.Runtime.Serialization.BinaryFormatter inside - Also available ready formatters in separate nuget packages: H.Formatters.Json - Supports `PipeAccessRule`'s(see `H.Pipes.AccessControl` nuget package) or more complex code to access using the `PipeServer.PipeStreamInitializeAction` property

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.38 576 6/2/2022
2.0.37 973 4/21/2022
2.0.35 1,368 3/17/2022
2.0.34 142 3/12/2022
2.0.33 83 3/12/2022
2.0.32 82 3/12/2022
2.0.31 190 3/11/2022
2.0.30 83 3/11/2022
2.0.29 85 3/11/2022
2.0.26 165 3/7/2022
2.0.25 88 3/6/2022
2.0.23 2,342 12/21/2021
2.0.22 139 12/21/2021
2.0.21 176 12/20/2021
2.0.20 141 12/20/2021
2.0.19 154 12/20/2021
2.0.18 149 12/20/2021
2.0.17 148 12/20/2021
2.0.16 144 12/20/2021
1.0.0.8 3,891 11/25/2021
1.0.0.7 5,689 11/24/2021
1.0.0.6 6,336 1/4/2021
1.0.0.5 4,128 12/9/2020
1.0.0.4 277 12/9/2020
1.0.0.3 1,169 11/22/2020
1.0.0.2 780 8/4/2020
1.0.0.1 2,648 1/28/2020
1.0.0 1,271 1/10/2020

⭐ Last 10 features:
- feat: Added BinaryFormatter.InternalFormatter as public property. 2022-03-18
- feat(AccessControl): Enabled PipeApplication.StartAsync for non-windows system without AllowUsersReadWrite. 2022-03-12
- feat(Inferno): Added net5/net6 targets. Added SupportedOSPlatform attributes. 2022-03-12
- feat(Inferno): Added EnableEncryption optional exception action. 2022-03-12
- feat(AccessControl): Added SupportedOSPlatform attribute to SetPipeSecurity. 2022-03-11
- feat(AccessControl): Added explicit net5.0 and net6.0 target frameworks. 2022-03-11
- feat: Excluded WaitForPipeDrain call for non-windows platforms. 2022-03-11
- feat: Added SystemTextJsonFormatter.Options property. 2022-03-06
- feat: Added connection close if EnableEncryption fails. 2021-12-21
- feat: Added WaitExchangeAsync use example. 2021-12-20

🐞 Last 10 bug fixes:
- fix: Added IOException ignoring for FlushAsync/WaitForPipeDrain. 2022-06-02
- fix: Fixed missing PipeStreamReader read check. Refactored. 2022-04-21
- fix(AccessControl): Fixed NET461 library to use Net Framework NamedPipeServerStream ctor. 2022-03-11
- fix: Fixed ValidatePublicKey. 2022-03-07
- fix: Fixed PipeClient.Connection set access. 2021-12-21
- fix: Fixed problem with multiple server encrypted connections. 2021-12-20
- fix: Fixed EnableEncryption client/server settings. 2021-12-20
- fix: Fixed Inferno KeyPair missing disposing. 2021-12-20
- fix: Fixed some Inferno KeyPair code. 2021-12-20
- fix: Converted Inferno KeyPair to internal class. 2021-12-20