Class NamedPipeClientTransport

Namespace

DotBoxD.Transports.NamedPipes

Assembly

DotBoxD.Transports.NamedPipes.dll

Client transport for connecting to a DotBoxD server over a named pipe.

public sealed class NamedPipeClientTransport : ITransport, IAsyncDisposable

Inheritance

object

NamedPipeClientTransport

Implements

ITransport

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

RpcTransportExtensions.ConnectPeerAsync(ITransport, ISerializer, RpcPeerOptions?, CancellationToken)

RpcTransportExtensions.ConnectPeerAsync(ITransport, ISerializer, Action<RpcPeer>, RpcPeerOptions?, CancellationToken)

Constructors

NamedPipeClientTransport(string, int)

public NamedPipeClientTransport(string pipeName, int maxMessageSize = 16777216)

Parameters

pipeName string

maxMessageSize int

NamedPipeClientTransport(string, string, int)

public NamedPipeClientTransport(string serverName, string pipeName, int maxMessageSize = 16777216)

Parameters

serverName string

pipeName string

maxMessageSize int

Fields

DefaultFrameReadIdleTimeout

Default inter-read idle timeout applied to client connections' in-progress frame body reads. Mirrors DefaultFrameReadIdleTimeout.

public static readonly TimeSpan DefaultFrameReadIdleTimeout

Field Value

TimeSpan

Properties

Connection

Gets the active connection (client-side).

public IRpcChannel? Connection { get; }

Property Value

IRpcChannel

FrameReadIdleTimeout

Inter-read idle timeout applied to the client connection's in-progress frame body reads. null uses DefaultFrameReadIdleTimeout; InfiniteTimeSpan disables it. See StreamConnection.

public TimeSpan? FrameReadIdleTimeout { get; init; }

Property Value

TimeSpan?

IsConnected

Gets whether there is an active connection.

public bool IsConnected { get; }

Property Value

bool

Methods

ConnectAsync(CancellationToken)

Establishes a connection (client-side).

public Task ConnectAsync(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

public ValueTask DisposeAsync()

Returns

ValueTask

A task that represents the asynchronous dispose operation.