NamedPipeClient

Namespace: TagBites.Pipes
Assembly: TagBites.Pipes.dll
Product: TagBites.Pipes v. 1.2.0

Sends requests to a NamedPipeServer on the local machine over a single connection.

public class NamedPipeClient : System.IDisposable

Inheritance: object → NamedPipeClient

Remarks

One instance serves one request at a time and is not safe for concurrent use. Use NamedPipeClientPool to send requests from several threads.

Constructors

NamedPipeClient(string)

Initializes a new instance of the NamedPipeClient class.

public NamedPipeClient(string pipeName)

Parameters

• pipeName string
  The name of the pipe to connect to.

Exceptions

• ArgumentNullException - pipeName is null.

Properties

IsConnected

Gets a value indicating whether the connection is believed to be alive.

public bool IsConnected { get; }

Property Value

bool

Remarks

This turns to false once a request fails or the client is disposed. A connection that the other side dropped while idle still reads as true, because a named pipe reveals that only when it is used.

IsDisposed

Gets a value indicating whether the client has been disposed.

public bool IsDisposed { get; }

Property Value

bool

PipeName

Gets the name of the pipe the client connects to.

public string PipeName { get; }

Property Value

string

Methods

Connect()

Opens the connection and agrees an encoding with the server. Returns at once when the client is already connected.

public void Connect()

Exceptions

• TimeoutException - The server did not accept within the timeout.
• ObjectDisposedException - The client has been disposed.

Connect(int)

Opens the connection and agrees an encoding with the server. Returns at once when the client is already connected.

public void Connect(int timeout)

Parameters

• timeout int
  How long to wait for the server, in milliseconds. Default: 100.

Exceptions

• TimeoutException - The server did not accept within the timeout.
• ObjectDisposedException - The client has been disposed.

ConnectAsync()

Opens the connection and agrees an encoding with the server. Returns at once when the client is already connected.

public Task ConnectAsync()

Returns

Task

Exceptions

• TimeoutException - The server did not accept within the timeout.
• ObjectDisposedException - The client has been disposed.

ConnectAsync(int, CancellationToken)

Opens the connection and agrees an encoding with the server. Returns at once when the client is already connected.

public Task ConnectAsync(int timeout, CancellationToken token)

Parameters

• timeout int
  How long to wait for the server, in milliseconds. Default: 100.
• token CancellationToken
  The token that cancels waiting for the server.

Returns

Task

Exceptions

• TimeoutException - The server did not accept within the timeout.
• ObjectDisposedException - The client has been disposed.

Dispose()

Closes the connection. The instance cannot be connected again.

public virtual void Dispose()

SendBytesAsync(string, byte[])

Sends the given bytes and returns the bytes that come back.

public Task<byte[]> SendBytesAsync(string address, byte[] message)

Parameters

• address string
  The address naming the operation. It must not start with --.
• message byte[]

Returns

Task<byte[]>

Whatever readResponse returns.

Exceptions

• NotSupportedException - The connection agreed on an encoding older than version 3, which carries text only.

Remarks

A separate name rather than an overload of SendRequestAsync(string, string), so that a call passing a plain null keeps compiling.

SendRequest(string, string)

Sends a request and waits for the response.

public string SendRequest(string address, string message)

Parameters

• address string
  The address naming the operation. It must not start with --.
• message string
  The message to send.

Returns

string

The response text, which is empty when the handler set no response.

Exceptions

• ArgumentNullException - address or message is null.
• ArgumentException - address starts with --, which is reserved.
• InvalidOperationException - The client is not connected.
• NamedPipeConnectionLostException - The connection broke while sending or receiving.
• NamedPipeServerRemoteException - The request handler on the server failed.

SendRequestAsync<T>(string, Func<Stream, Task>, Func<Stream, Task<T>>)

Sends a request written by a callback and reads the response with another one, so neither side has to hold the whole payload in memory.

public Task<T> SendRequestAsync(string address, Func<Stream, Task> writeMessage, Func<Stream, Task<T>> readResponse)

Parameters

• address string
  The address naming the operation. It must not start with --.
• writeMessage Func<Stream, Task>
  Writes the request body.
• readResponse Func<Stream, Task<T>>
  Reads the response body.

Returns

Task<T>

Whatever readResponse returns.

Exceptions

• NotSupportedException - The connection agreed on an encoding older than version 3, which carries text only.

SendRequestAsync(string, string)

Sends a request and waits for the response.

public Task<string> SendRequestAsync(string address, string message)

Parameters

• address string
  The address naming the operation. It must not start with --.
• message string
  The message to send.

Returns

Task<string>

The response text, which is empty when the handler set no response.

Exceptions

• ArgumentNullException - address or message is null.
• ArgumentException - address starts with --, which is reserved.
• InvalidOperationException - The client is not connected.
• NamedPipeConnectionLostException - The connection broke while sending or receiving.
• NamedPipeServerRemoteException - The request handler on the server failed.