Class NamedPipeServerTransport

Namespace

DotBoxD.Transports.NamedPipes

Assembly

DotBoxD.Transports.NamedPipes.dll

Server transport for accepting DotBoxD connections over a named pipe.

public sealed class NamedPipeServerTransport : IServerTransport, IAsyncDisposable

Inheritance

object

NamedPipeServerTransport

Implements

IServerTransport

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NamedPipeServerTransport(string, int, int)

public NamedPipeServerTransport(string pipeName, int maxAllowedServerInstances = -1, int maxMessageSize = 16777216)

Parameters

pipeName string

maxAllowedServerInstances int

maxMessageSize int

Fields

DefaultFrameReadIdleTimeout

Default inter-read idle timeout applied to accepted connections' in-progress frame body reads (30 seconds). Mirrors TcpConnection.DefaultFrameReadIdleTimeout so accepted pipe connections get the same finite slow-loris defense the TCP transport applies by default.

public static readonly TimeSpan DefaultFrameReadIdleTimeout

Field Value

TimeSpan

Properties

FrameReadIdleTimeout

Inter-read idle timeout applied to accepted connections' in-progress frame body reads (slow-loris defense). null uses DefaultFrameReadIdleTimeout; InfiniteTimeSpan disables it. See StreamConnection.

public TimeSpan? FrameReadIdleTimeout { get; init; }

Property Value

TimeSpan?

Methods

AcceptAsync(CancellationToken)

Accepts an incoming connection.

public Task<IRpcChannel> AcceptAsync(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task<IRpcChannel>

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.

StartAsync(CancellationToken)

Starts listening for connections.

public Task StartAsync(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task

StopAsync(CancellationToken)

Stops listening for connections.

public Task StopAsync(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task