Interface IConnectionScope<TKey, TClient>

Auto reserves clients and manages their lifetimes.

Inherited Members

IConnectionScope<TKey>.ConnectAndGetBaggageAsync<TBaggage>(TKey, CancellationOptions?)

IConnectionScope<TKey>.RemoveConnection(TKey)

ICanConnect<TKey>.ConnectAsync(TKey, CancellationOptions?)

ICanConnect<TKey>.ConnectAsync(IEnumerable<TKey>, CancellationOptions?)

IHoldsBaggage<TKey>.GetBaggage<TBaggage>(TKey)

IHoldsBaggage<TKey>.GetAllBaggage<TBaggage>()

IAsyncDisposable.DisposeAsync()

IDisposable.Dispose()

Namespace: Microsoft.XboxStudios.ClientManager

Assembly: ClientManager.Abstractions.dll

Syntax

public interface IConnectionScope<TKey, TClient> : IConnectionScope<TKey>, ICanConnect<TKey>, IHoldsBaggage<TKey>, IAsyncDisposable, IDisposable where TKey : notnull where TClient : class

Type Parameters

Name	Description
TKey	The type of key to use.
TClient	The type of client to use.

Methods

ConnectAndGetClientAsync(TKey, CancellationOptions?)

Connects if necessary and gets the client associated with a key.

Declaration

ValueTask<TClient?> ConnectAndGetClientAsync(TKey key, CancellationOptions? co = null)

Parameters

Type	Name	Description
TKey	key	The TKey to use to fetch a baggage.
CancellationOptions?	co	The Microsoft.XboxStudios.Bifrost.CancellationOptions.

Returns

Type	Description
ValueTask<TClient>	The client if possible, null otherwise.