H.Formatters.Inferno 2.0.34

.NET 5.0 .NET Standard 2.0 .NET Framework 4.6.2

There is a newer version of this package available.
See the version list below for details.

dotnet add package H.Formatters.Inferno --version 2.0.34

NuGet\Install-Package H.Formatters.Inferno -Version 2.0.34

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="H.Formatters.Inferno" Version="2.0.34" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add H.Formatters.Inferno --version 2.0.34

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: H.Formatters.Inferno, 2.0.34"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install H.Formatters.Inferno as a Cake Addin
#addin nuget:?package=H.Formatters.Inferno&version=2.0.34

// Install H.Formatters.Inferno as a Cake Tool
#tool nuget:?package=H.Formatters.Inferno&version=2.0.34

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

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

// 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. It is based on this library, but provides an IPC implementation based on C# interfaces. It supports remote method invocation, asynchronous methods, cancellation via CancellationToken, events, and so on.

Contacts

mail

Product	Compatible and additional computed target framework versions.
.NET	net5.0 is compatible. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETFramework 4.6.2
- H.Formatters (>= 2.0.34)
- H.Pipes (>= 2.0.34)
- Inferno (>= 1.6.4)
- Microsoft.Bcl.AsyncInterfaces (>= 6.0.0)
.NETStandard 2.0
- H.Formatters (>= 2.0.34)
- H.Pipes (>= 2.0.34)
- Inferno (>= 1.6.4)
- Microsoft.Bcl.AsyncInterfaces (>= 6.0.0)
net5.0
- H.Formatters (>= 2.0.34)
- H.Pipes (>= 2.0.34)
- Inferno (>= 1.6.4)
net6.0
- H.Formatters (>= 2.0.34)
- H.Pipes (>= 2.0.34)
- Inferno (>= 1.6.4)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
14.0.0	88	10/21/2024
2.2.2-dev.2	47	10/21/2024
2.2.1	104	10/19/2024
2.2.1-dev.2	72	10/19/2024
2.1.0-dev.322	97	1/20/2024
2.1.0-dev.318	122	12/18/2023
2.0.59	14,854	12/8/2023
2.0.56	176	11/27/2023
2.0.53	378	7/24/2023
2.0.51	173	5/25/2023
2.0.47	654	2/27/2023
2.0.46	267	2/26/2023
2.0.45	1,757	2/2/2023
2.0.44	345	1/10/2023
2.0.43	326	1/5/2023
2.0.42	1,020	9/14/2022
2.0.41	430	9/9/2022
2.0.40	451	8/26/2022
2.0.39	373	8/26/2022
2.0.38	591	6/2/2022
2.0.37	465	4/21/2022
2.0.35	420	3/17/2022
2.0.34	438	3/12/2022
2.0.33	447	3/12/2022
2.0.32	405	3/12/2022
2.0.31	410	3/11/2022
2.0.30	417	3/11/2022
2.0.29	443	3/11/2022
2.0.26	438	3/7/2022
2.0.25	416	3/6/2022
2.0.23	300	12/21/2021
2.0.22	262	12/21/2021
2.0.21	266	12/20/2021
2.0.20	263	12/20/2021
2.0.19	291	12/20/2021
2.0.18	284	12/20/2021
2.0.17	278	12/20/2021
2.0.16	264	12/20/2021

⭐ Last 10 features:
- 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
- feat: Added Inferno PipeConnectionExtensions.WaitExchangeAsync extension. 2021-12-20

🐞 Last 10 bug fixes:
- 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
- fix: Fixed Inferno namespaces. 2021-12-20
- fix: Fixed Inferno extensions memory leak. 2021-12-20