NamedPipeClient class

Streaming transport client implementation that uses named pipes for inter-process communication.

Constructors

NamedPipeClient(string, RequestHandler, boolean)

Creates a new instance of the NamedPipeClient class.

Methods

connect()

Establish a connection with no custom headers.

disconnect()

Disconnect the client.

send(StreamingRequest)

Task used to send data over this client connection.

Constructor Details

NamedPipeClient(string, RequestHandler, boolean)

Creates a new instance of the NamedPipeClient class.

new NamedPipeClient(baseName: string, requestHandler?: RequestHandler, autoReconnect?: boolean)

Parameters

baseName

string

The named pipe to connect to.

requestHandler
RequestHandler

Optional RequestHandler to process incoming messages received by this client.

autoReconnect

boolean

Optional setting to determine if the client sould attempt to reconnect automatically on disconnection events. Defaults to true.

Method Details

connect()

Establish a connection with no custom headers.

function connect(): Promise<void>

Returns

Promise<void>

disconnect()

Disconnect the client.

function disconnect()

send(StreamingRequest)

Task used to send data over this client connection.

function send(request: StreamingRequest): Promise<IReceiveResponse>

Parameters

request
StreamingRequest

The StreamingRequest to send.

Returns

Promise<IReceiveResponse>

A promise for an instance of IReceiveResponse on completion of the send operation.