Class
PipeCommunication

Static methods used for NamedPipe communications.

Definition

Namespace:ArtOfTest.WebAii.Messaging.Process

Assembly:ArtOfTest.WebAii.dll

Syntax:

cs-api-definition
public static class PipeCommunication

Inheritance: objectPipeCommunication

Fields

CommandPipeName

The command pipe name

Declaration

cs-api-definition
public static string CommandPipeName

Field Value

string

ServicePipeName

The async pipe name.

Declaration

cs-api-definition
public static string ServicePipeName

Field Value

string

Methods

ReadCommandFromPipe<T>(PipeStream)

Reads a command from the pipe stream as a command object.

Declaration

cs-api-definition
public static T ReadCommandFromPipe<T>(PipeStream pipe) where T : PipeCommand

Parameters

pipe

PipeStream

The pipe to use.

Returns

T

The command

ReadMessageFromPipe<T>(PipeStream, IEnumerable<Type>)

Reads a pipe message from the pipe stream.

Declaration

cs-api-definition
public static T ReadMessageFromPipe<T>(PipeStream pipe, IEnumerable<Type> knownTypes = null) where T : PipeMessage

Parameters

pipe

PipeStream

The pipe to use.

knownTypes

IEnumerable<Type>

Additional nested types required for deserialization.

Returns

T

The pipe message

WriteCommandToPipe(PipeCommand, PipeStream, bool)

Write a command to a specific named pipe.

Declaration

cs-api-definition
public static void WriteCommandToPipe(PipeCommand command, PipeStream pipe, bool waitForDrain)

Parameters

command

PipeCommand

The command

pipe

PipeStream

The pipe to use

waitForDrain

bool

Whether to wait for the pipe to be drained.

WriteMessageToPipe<T>(T, PipeStream, bool, IEnumerable<Type>)

Write a pipe message to the pipe stream.

Declaration

cs-api-definition
public static void WriteMessageToPipe<T>(T data, PipeStream pipe, bool waitForDrain, IEnumerable<Type> knownTypes = null) where T : PipeMessage

Parameters

data

T

The pipe message.

pipe

PipeStream

The pipe to use.

waitForDrain

bool

Whether to wait for the pipe to be drained.

knownTypes

IEnumerable<Type>

Additional nested types required for serialization.