H.Pipes 2.0.23

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

// Install H.Pipes as a Cake Tool
#tool nuget:?package=H.Pipes&version=2.0.23
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);

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
{
    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.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

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

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

NuGet packages (5)

Showing the top 5 NuGet packages that depend on H.Pipes:

Package Downloads
H.Pipes.AccessControl

This package adds AccessControl extensions for PipeServerSetPipeSecurity()

H.ProxyFactory.Pipes

Features: - Create proxy objects that look exactly like the original objects - Proxy target can be located anywhere where there is access to pipes ⭐ Last 10 features: - feat: Updated NuGet packages. 2022-01-19 - feat: Added ContinuousIntegrationBuild. 2021-11-29 - feat: Added separate H.ProxyFactory.Remote library. 2021-11-29 - feat: Added separate H.Ipc.Core library. Refactored. 2021-11-29 - feat: Added RemoteProxyServer.ObjectCreated event. 2021-11-28 - feat: Implemented safe CreateObjectAsync. 2021-10-30 - feat: Added try catch to example app. 2021-10-30 - feat: Added CLSCompliant(true). 2021-10-30 - feat: to auto-releases. 2021-10-29 - feat: Implemented example WPF app. 2021-10-29 🐞 Last 10 bug fixes: - fix(test): Removed H.Recorders.NAudioRecorder package from tests. 2022-01-19 - fix: Renamed H.Ipc.Messages to H.ProxyFactory.Remote.Messages. 2021-11-30 - fix: Changed CI build to windows-latest. 2021-10-30 - fix: Added Factory.LoadAssemblyAsync to example app. 2021-10-30 - fix: Fixed H.ProxyFactory.Pipes warnings. 2021-10-30 - fix: Fixed H.ProxyFactory warnings. 2021-10-30

H.Utilities.PipeProxyFactory

Features: - Create proxy objects that look exactly like the original objects - Proxy target can be located anywhere where there is access to pipes

H.Formatters.Inferno

This package adds InfernoFormatter(based on Inferno). It allows encrypt your messages.

H.Deskband.Core

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.23 209 12/21/2021
2.0.22 80 12/21/2021
2.0.21 86 12/20/2021
2.0.20 77 12/20/2021
2.0.19 85 12/20/2021
2.0.18 91 12/20/2021
2.0.17 86 12/20/2021
2.0.16 86 12/20/2021
2.0.15 74 12/20/2021
2.0.14 148 12/5/2021
2.0.13 75 12/5/2021
1.15.12 86 12/5/2021
1.15.11 827 11/29/2021
1.15.10 3,176 11/25/2021
1.15.9 2,227 11/25/2021
1.15.8 2,472 11/25/2021
1.15.7 2,352 11/25/2021
1.15.6 3,593 11/24/2021
1.15.4 5,590 11/24/2021
1.15.2 422 10/22/2021
1.15.1 125 10/22/2021
1.14.8 4,007 1/4/2021
1.14.7 1,292 12/15/2020
1.14.6 3,325 12/9/2020
1.14.5 198 12/9/2020
1.14.4 1,007 11/22/2020
1.14.2 195 11/22/2020
1.14.1 434 10/8/2020
1.14.0 292 10/8/2020
1.13.4 334 10/8/2020
1.13.1 387 7/5/2020
1.13.0 416 5/20/2020
1.12.3 408 2/2/2020
1.12.2 779 2/1/2020
1.12.1 332 2/1/2020
1.0.12 871 1/29/2020
1.0.11 442 1/28/2020
1.0.10 298 1/28/2020
1.0.9 347 1/14/2020
1.0.8 306 1/14/2020
1.0.7 486 1/12/2020
1.0.6.1 367 1/11/2020
1.0.6 419 1/10/2020
1.0.5 291 1/10/2020
1.0.4 278 1/10/2020
1.0.3 349 1/10/2020
1.0.2.3 306 1/9/2020
1.0.2.2 312 1/9/2020
1.0.2.1 295 1/9/2020
1.0.2 295 1/8/2020
1.0.1 304 1/8/2020
1.0.0 275 1/7/2020

⭐ Last 10 features:
- 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
- feat: IPipeClient Connection/PipeName/ServerName now public properties. 2021-12-20
- feat: Updated README. 2021-12-20
- feat: Added ContinuousIntegrationBuild. 2021-12-20
- feat: Updated Microsoft.SourceLink.GitHub to 1.1.1. 2021-12-20
- feat: Added H.Formatters.Inferno EnableEncryption extensions. 2021-12-20
- feat: Added IFormatter to IPipeClient interface. 2021-12-20
- feat: Converted formatter Internal methods to protected. 2021-12-20

🐞 Last 10 bug fixes:
- 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
- fix: Deleted InfernoFormatter.SerializeAsyncIfPossible. 2021-12-20
- fix: Fixed some Inferno Formatter code. 2021-12-20