H.Formatters.Json 12.0.3.7

.NET Standard 2.0 .NET Framework 4.5.1
Suggested Alternatives

H.Formatters.Newtonsoft.Json

Additional Details

The package has been renamed to add H.Formatters.System.Text.Json.

Install-Package H.Formatters.Json -Version 12.0.3.7
dotnet add package H.Formatters.Json --version 12.0.3.7
<PackageReference Include="H.Formatters.Json" Version="12.0.3.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add H.Formatters.Json --version 12.0.3.7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: H.Formatters.Json, 12.0.3.7"
#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.Json as a Cake Addin
#addin nuget:?package=H.Formatters.Json&version=12.0.3.7

// Install H.Formatters.Json as a Cake Tool
#tool nuget:?package=H.Formatters.Json&version=12.0.3.7
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.Json
  • 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

// 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.
Install-Package H.Formatters.Json

// If you want to transfer any data that can be serialized/deserialized in binary using [Ceras](https://github.com/rikimaru0345/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.Id} is now connected!");

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

await server.StartAsync();

await Task.Delay(Timeout.InfiniteTimeSpan);

P.S. To use the server inside the WinForms application, use Task.Run(). This creates a new thread for it.

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
{
    Id = new Random().Next(),
    Text = "Hello!",
});

await Task.Delay(Timeout.InfiniteTimeSpan);

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.Json
Install-Package H.Formatters.Ceras
using H.Formatters;

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

Access Control

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();

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

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
12.0.3.7 9,091 11/24/2021
12.0.3.6 10,953 1/4/2021
12.0.3.5 3,826 12/9/2020
12.0.3.4 3,854 12/9/2020
12.0.3.3 3,794 11/22/2020
12.0.3.2 3,883 8/4/2020
12.0.3.1 3,980 1/28/2020
12.0.3 4,031 1/10/2020

⭐ Last 10 features:
- feat: Updated README. 2021-11-25
- feat: Added CerasFormatter package. 2021-11-25
- feat: Changed minimal requiments to .NET Framework 4.5.1. 2021-11-25
- feat: Deleted Wire formatter(it's deprecated). 2021-10-22
- feat: To auto-versioning. 2021-10-22
- feat: To C# 10. Part 2. 2021-10-22
- feat: To net6.0 and C#10. Part 1. 2021-10-22
- feat: Added README to NuGet package. 2021-10-22

🐞 Last 10 bug fixes:
- fix: Fixed await using ConfigureAwait(false) missing bug. 2021-10-22
- fix: Fixed H.Pipes.AccessControl warnings. 2021-10-22