IpcAnonymousPipes 1.2.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package IpcAnonymousPipes --version 1.2.2                
NuGet\Install-Package IpcAnonymousPipes -Version 1.2.2                
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="IpcAnonymousPipes" Version="1.2.2" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add IpcAnonymousPipes --version 1.2.2                
#r "nuget: IpcAnonymousPipes, 1.2.2"                
#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 IpcAnonymousPipes as a Cake Addin
#addin nuget:?package=IpcAnonymousPipes&version=1.2.2

// Install IpcAnonymousPipes as a Cake Tool
#tool nuget:?package=IpcAnonymousPipes&version=1.2.2                

IpcAnonymousPipes

Interprocess communication using anonymus pipes. The goal of this project is to provide a simple framework to send and receive byte arrays over anonymus pipes efficiently. You may use a serialization library of your choice on top of this to implement messaging.

  • Targets .NET Standard 2.0
  • Lightweight and easy to use
  • Client-Server architecture
  • One-to-one duplex communication
  • Works with simple byte arrays

Usage

NuGet package

Install-Package IpcAnonymousPipes

PipeServer

The server side PipeServer will create two anonymus pipes: input and output. The handles will be passed to the client app as process arguments.

void StartServer()
{
    // Create pipe server
    Server = new PipeServer();
    
    // Start client process with command line arguments
    Process.Start("MyClient.exe", Server.GetClientArgs());
    
    // Receiving on background thread
    Server.ReceiveAsync(stream =>
    {
        Console.WriteLine(Encoding.UTF8.GetString(stream.ReadToEnd()));
    });
    
    // Wait for client connection
    Server.WaitForClient();
    
    // Say Hi to the client
    Server.Send(Encoding.UTF8.GetBytes("Hi!"));
}

PipeClient

This is a minimal client implementation with a console application. The Client will be disposed when the server sends a disconnect signal to this client.

static void Main(string[] args)
{
    // Create pipe client
    // The empty constructor parses command line arguments to get the pipe handles.
    using (var Client = new PipeClient())
    {
        // Receiving on background thread
        Client.ReceiveAsync(stream =>
        {
            Console.WriteLine(Encoding.UTF8.GetString(stream.ReadToEnd()));
        });

        // Read line from console, press ENTER to send
        while (Client.IsConnected)
            Client.Send(Encoding.UTF8.GetBytes(Console.ReadLine()));
    }
}

Example applications

You can find two WPF applications in the repository. I wrote them in order to demonstrate the two-way communication between the server and the client.

ServerWpfApp

Download the source and build the solution. Then you can start the ServerWpfApp project.
The ServerWpfApp project does not reference ClientWpfApp project, they are completely independent from each other. My goal was to run the client inside a standalone process, so it lives in it's own Application Domain.

ClientWpfApp

The client ClientWpfApp will be started automatically by ServerWpfApp. You can send messages by typing into the textbox and pressing the Send button.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

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
1.2.3 275 12/7/2023
1.2.2 437 12/11/2021
1.2.1 284 12/11/2021
1.2.0 268 12/4/2021
1.1.0 265 12/2/2021
1.0.2 1,377 11/28/2021
1.0.1 1,353 11/28/2021
1.0.0 1,374 11/28/2021