NamedPipeClientPoolLink

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

Holds one connection taken from a NamedPipeClientPool for as long as the link is alive, so several requests run on the same connection.

public class NamedPipeClientPoolLink : System.IDisposable

Inheritance: object → NamedPipeClientPoolLink

Remarks

Disposing the link returns the connection to the pool. Until then the pool cannot hand that connection to anyone else, so a link that is never disposed shrinks the pool by one.

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 connection has been returned to the pool.

public bool IsDisposed { get; }

Property Value

bool

PipeName

Gets the name of the pipe the connection points 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()

Returns the connection to the pool.

public virtual void Dispose()

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(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.