Class ProtoDeviceConnect

Namespace

ProtoTest.Devices

Assembly

ProtoTest.Devices.dll

Runs one device transport connect under its configured timeout - the rule every shipped device transport shares: the attempt token is the timeout authority, so any failure that surfaces after it fires - an OperationCanceledException or a transport that aborts the connect another way - is reported as a TimeoutException naming the target. A caller's own cancellation is never reclassified, and the caller keeps ownership of the connection it created.

public static class ProtoDeviceConnect

Inheritance

object

ProtoDeviceConnect

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

WithTimeoutAsync<TConnection>(string, TimeSpan, Func<CancellationToken, Task<TConnection>>, CancellationToken)

Connects through connect with a linked token that expires after timeout, so the transport call cannot outlive the connect bound. The connection the call returns is returned unchanged; a transport that owns its socket disposes it on failure itself.

public static Task<TConnection> WithTimeoutAsync<TConnection>(string target, TimeSpan timeout, Func<CancellationToken, Task<TConnection>> connect, CancellationToken cancellationToken)

Parameters

target string

What the timeout message names: the address, or a path for an in-process endpoint.

timeout TimeSpan

The registered connect timeout.

connect Func<CancellationToken, Task<TConnection>>

The transport's connect call, invoked with the attempt token.

cancellationToken CancellationToken

The caller's cancellation; it wins over the timeout.

Returns

Task<TConnection>

The transport's connection.

Type Parameters

TConnection

The transport's connection type.

Exceptions

TimeoutException

The attempt token fired before the connect completed.