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, IAsyncDisposableInheritance
Section titled “Inheritance”object ← NamedPipeClientTransport
Implements
Section titled “Implements”Inherited Members
Section titled “Inherited Members”object.Equals(object), object.Equals(object, object), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object, object), object.ToString()
Extension Methods
Section titled “Extension Methods”RpcTransportExtensions.ConnectPeerAsync(ITransport, ISerializer, RpcPeerOptions?, CancellationToken), RpcTransportExtensions.ConnectPeerAsync(ITransport, ISerializer, Action<RpcPeer>, RpcPeerOptions?, CancellationToken)
Constructors
Section titled “Constructors”NamedPipeClientTransport(string, int)
Section titled “ NamedPipeClientTransport(string, int)”public NamedPipeClientTransport(string pipeName, int maxMessageSize = 16777216)Parameters
Section titled “Parameters”pipeName string
maxMessageSize int
NamedPipeClientTransport(string, string, int)
Section titled “ NamedPipeClientTransport(string, string, int)”public NamedPipeClientTransport(string serverName, string pipeName, int maxMessageSize = 16777216)Parameters
Section titled “Parameters”serverName string
pipeName string
maxMessageSize int
Fields
Section titled “Fields”DefaultFrameReadIdleTimeout
Section titled “ DefaultFrameReadIdleTimeout”Default idle timeout applied to client connections’ frame reads.
Mirrors DotBoxD.Transports.NamedPipes.NamedPipeServerTransport.DefaultFrameReadIdleTimeout.
public static readonly TimeSpan DefaultFrameReadIdleTimeoutField Value
Section titled “Field Value”Properties
Section titled “Properties”Connection
Section titled “ Connection”Gets the active connection (client-side).
public IRpcChannel? Connection { get; }Property Value
Section titled “Property Value”FrameReadIdleTimeout
Section titled “ FrameReadIdleTimeout”Idle timeout applied to the client connection’s frame reads.
null uses DotBoxD.Transports.NamedPipes.NamedPipeClientTransport.DefaultFrameReadIdleTimeout;
System.Threading.Timeout.InfiniteTimeSpan disables it. See DotBoxD.Services.Transport.StreamConnection.
public TimeSpan? FrameReadIdleTimeout { get; init; }Property Value
Section titled “Property Value”IsConnected
Section titled “ IsConnected”Gets whether there is an active connection.
public bool IsConnected { get; }Property Value
Section titled “Property Value”Methods
Section titled “Methods”ConnectAsync(CancellationToken)
Section titled “ ConnectAsync(CancellationToken)”Establishes a connection (client-side).
public Task ConnectAsync(CancellationToken ct = default)Parameters
Section titled “Parameters”Returns
Section titled “Returns”DisposeAsync()
Section titled “ DisposeAsync()”Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.
public ValueTask DisposeAsync()Returns
Section titled “Returns”A task that represents the asynchronous dispose operation.