NamedPipeMessage 3.2.0.18

dotnet add package NamedPipeMessage --version 3.2.0.18
NuGet\Install-Package NamedPipeMessage -Version 3.2.0.18
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="NamedPipeMessage" Version="3.2.0.18" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NamedPipeMessage --version 3.2.0.18
#r "nuget: NamedPipeMessage, 3.2.0.18"
#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 NamedPipeMessage as a Cake Addin
#addin nuget:?package=NamedPipeMessage&version=3.2.0.18

// Install NamedPipeMessage as a Cake Tool
#tool nuget:?package=NamedPipeMessage&version=3.2.0.18

The easiest way to consume this library is to use NamedPipeClient and NamedPipeServer

Pipe Message is used to construct message chains between NamedPipeClientStream and NamedPipeServerStream

Client Example

using NamedPipeClientStream pipeClient = new(".", "testpipe", PipeDirection.InOut);

if (new NamedPipeHandshakeClient(pipeClient).Client(sharedSecret))
{
    return new NamedPipeMessage(pipeClient).WriteStringWaitForRead(dataForServer) == "Success";
}

Server Example

NamedPipeServerStream _pipeServer = new NamedPipeServerStream("testpipe", PipeDirection.InOut, 1, PipeTransmissionMode.Message, PipeOptions.WriteThrough);

NamedPipeHandshakeServer _pipeHandshake = new(_pipeServer);

string clientResponse = _pipeHandshake.Server(sharedSecret);

if (clientResponse != null)
{
    new NamedPipeMessage(_pipeServer).WriteString("Success");
}

Named Pipe Message

Used Internally by NamedPipeClient and NamedPipeServer

WaitForRead()

Wait for the other end of the pipe to send a message

This will timeout and return null after 60 seconds if the other end does not send anything

The timeout can be changed with PipeApplicationGlobals.SetTimeoutMs(500);

new NamedPipeMessage(pipeServer).WaitForRead()

WriteStringWaitForRead(string data)

Send a message and wait for the other end of the pipe to send a message back

This will timeout and return null after 60 seconds if the other end does not send anything

The timeout can be changed with PipeApplicationGlobals.SetTimeoutMs(500);

new NamedPipeMessage(pipeClient).WriteStringWaitForRead(sharedSecret + "/-\\" + pipeName)

TryReadString()

Try read a string from the underlying Stream

clientData = TryReadString()

WriteString(string data)

Write a data string to the underlying Stream

new NamedPipeMessage(pipeServer).WriteString("Success")

NamedPipeHandshakeClient

Used by the NamedPipeClient to validate the shared secret from the NamedPipeServer

new NamedPipeHandshakeClient(pipeClient).Client(sharedSecret)

NamedPipeHandshakeServer

Used by the NamedPipeServer to validate the shared secret from the NamedPipeClient

new NamedPipeHandshakeServer(pipeServer).Server(sharedSecret)

Copyright S Christison �2024

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.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on NamedPipeMessage:

Package Downloads
NamedPipeClient

Communicates with NamedPipeServer using NamedPipeMessage and secures the pipe with a Shared Secret providing fast and safe communication with other applications over a named pipe using strings or bytes

NamedPipeServer

Communicates with NamedPipeClient using NamedPipeMessage and secures the pipe with a Shared Secret providing fast and safe communication with other applications over a named pipe using strings or bytes

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.2.0.18 94 5/14/2024

-----------------
Please use the most recent version visible on Nuget, old versions are hidden but can still be downloaded indirectly