PipeMessage 1.0.2.6

Suggested Alternatives

NamedPipeMessage

Additional Details

Please use NamedPipeMessage instead

The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore.
dotnet add package PipeMessage --version 1.0.2.6
NuGet\Install-Package PipeMessage -Version 1.0.2.6
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="PipeMessage" Version="1.0.2.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PipeMessage --version 1.0.2.6
#r "nuget: PipeMessage, 1.0.2.6"
#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 PipeMessage as a Cake Addin
#addin nuget:?package=PipeMessage&version=1.0.2.6

// Install PipeMessage as a Cake Tool
#tool nuget:?package=PipeMessage&version=1.0.2.6

The easiest way to consume this library is to use PipeClient and PipeServer

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

Client Example

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

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

Server Example

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

PipeHandshakeServer _pipeHandshake = new(_pipeServer);

string clientResponse = _pipeHandshake.Server(sharedSecret);

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

Pipe Message

Used Internally by PipeClient and PipeServer

WaitForRead()

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

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

new PipeMessage(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 2 seconds if the other end does not send anything

new PipeMessage(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 PipeMessage(pipeServer).WriteString("Success")

PipeHandshakeClient

Used by the PipeClient to validate the PipeServer

new PipeHandshakeClient(pipeClient).Client(sharedSecret)

PipeHandshakeServer

Used by the PipeServer to validate the PipeClient

new PipeHandshakeServer(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

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

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