H.Formatters.MessagePack
2.1.0-dev.322
See the version list below for details.
dotnet add package H.Formatters.MessagePack --version 2.1.0-dev.322
NuGet\Install-Package H.Formatters.MessagePack -Version 2.1.0-dev.322
<PackageReference Include="H.Formatters.MessagePack" Version="2.1.0-dev.322" />
paket add H.Formatters.MessagePack --version 2.1.0-dev.322
#r "nuget: H.Formatters.MessagePack, 2.1.0-dev.322"
// Install H.Formatters.MessagePack as a Cake Addin #addin nuget:?package=H.Formatters.MessagePack&version=2.1.0-dev.322&prerelease // Install H.Formatters.MessagePack as a Cake Tool #tool nuget:?package=H.Formatters.MessagePack&version=2.1.0-dev.322&prerelease
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(seeH.Pipes.AccessControl
nuget package) or more complex code to access using thePipeServer.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
[!WARNING] 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
[!WARNING] 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 Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. 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 is compatible. 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 is compatible. 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 was computed. 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. |
-
.NETStandard 2.0
- H.Formatters (>= 2.1.0-dev.322)
- MessagePack (>= 2.5.140)
-
net6.0
- H.Formatters (>= 2.1.0-dev.322)
- MessagePack (>= 2.5.140)
-
net7.0
- H.Formatters (>= 2.1.0-dev.322)
- MessagePack (>= 2.5.140)
-
net8.0
- H.Formatters (>= 2.1.0-dev.322)
- MessagePack (>= 2.5.140)
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 | 80 | 10/21/2024 |
2.2.2-dev.2 | 38 | 10/21/2024 |
2.2.1 | 99 | 10/19/2024 |
2.2.1-dev.2 | 65 | 10/19/2024 |
2.1.0-dev.322 | 90 | 1/20/2024 |
2.1.0-dev.318 | 123 | 12/18/2023 |
2.0.59 | 42,175 | 12/8/2023 |
2.0.56 | 684 | 11/27/2023 |
2.0.53 | 189 | 7/24/2023 |
2.0.51 | 138 | 5/25/2023 |
2.0.47 | 308 | 2/27/2023 |
2.0.46 | 231 | 2/26/2023 |
2.0.45 | 246 | 2/2/2023 |
2.0.44 | 293 | 1/10/2023 |
2.0.43 | 291 | 1/5/2023 |
2.0.42 | 435 | 9/14/2022 |
2.0.41 | 397 | 9/9/2022 |
2.0.40 | 389 | 8/26/2022 |
2.0.39 | 374 | 8/26/2022 |
2.0.38 | 432 | 6/2/2022 |
2.0.37 | 455 | 4/21/2022 |
2.0.35 | 422 | 3/17/2022 |
2.0.34 | 396 | 3/12/2022 |
2.0.33 | 441 | 3/12/2022 |
2.0.32 | 435 | 3/12/2022 |
2.0.31 | 408 | 3/11/2022 |
2.0.30 | 440 | 3/11/2022 |
2.0.29 | 435 | 3/11/2022 |
2.0.26 | 409 | 3/7/2022 |
2.0.25 | 420 | 3/6/2022 |
2.0.23 | 278 | 12/21/2021 |
2.0.22 | 277 | 12/21/2021 |
2.0.21 | 257 | 12/20/2021 |
2.0.20 | 254 | 12/20/2021 |
2.0.19 | 269 | 12/20/2021 |
2.0.18 | 265 | 12/20/2021 |
2.0.17 | 269 | 12/20/2021 |
2.0.16 | 284 | 12/20/2021 |
1.0.0.8 | 294 | 12/20/2021 |
⭐ Last 10 features:
- feat: Added MessagePackFormatter<T1> to H.Formatters.MessagePack lib. 2024-01-20
- feat: Added PipeClient.CreatePipeStreamForConnectionFunc. 2023-12-08
- feat: Updated versioning. 2023-12-08
- feat: Added support for WriteOnly PipeServer. 2023-12-08
- feat: Added PipeServer.CreatePipeStreamForConnectionFunc. 2023-12-08
- feat: Use MessagePackFormatter by default on net8.0. 2023-11-27
- feat: Update to net8.0. 2023-11-27
- feat: Updated packages. 2023-07-24
- feat: Added PipeApplication.StartAsync(args). 2023-02-27
- feat: Added IPipeClient.CreatePipeStreamFunc. Closes #29. 2023-02-02
🐞 Last 10 bug fixes:
- fix: Changed default formatter to SystemTextJsonFormatter. 2023-12-18
- fix: Fixed problems with $(BUILD_NUMBER). 2023-12-08
- test: Try to fix test for windows. 2023-12-08
- fix: Fixed bug with PipeStream.ReadAsync on non windows systems. 2023-05-26
- fix: Now EventExtensions is internal class. 2023-02-26
- fix: Fixed Connection.Disconnected unhandled exception bug. 2022-09-14
- fix: Fixed SemaphoreSlim usage. Fixes #24. 2022-08-26
- fix: Fixes #24. 2022-08-26
- fix: Added IOException ignoring for FlushAsync/WaitForPipeDrain. 2022-06-02
- fix: Fixed missing PipeStreamReader read check. Refactored. 2022-04-21