Interface ICanDisconnect<TKey>

Disconnects clients.

Namespace: Microsoft.XboxStudios.ClientManager

Assembly: ClientManager.Abstractions.dll

Syntax

public interface ICanDisconnect<TKey> where TKey : notnull

Type Parameters

Name	Description
TKey	The type of key to use.

Methods

Disconnect(IEnumerable<TKey>)

Disconnect clients from a game instance synchronously.

Declaration

void Disconnect(IEnumerable<TKey> keys)

Parameters

Type	Name	Description
IEnumerable<TKey>	keys	The keys to use to fetch clients and attempt disconnections synchronously.

Disconnect(TKey)

Disconnects a client from a game instance synchronously.

Declaration

void Disconnect(TKey key)

Parameters

Type	Name	Description
TKey	key	The TKey to use to fetch a client and attempt a disconnection.

DisconnectAsync(IEnumerable<TKey>)

Disconnect clients from a game instance asynchronously.

Declaration

ValueTask DisconnectAsync(IEnumerable<TKey> keys)

Parameters

Type	Name	Description
IEnumerable<TKey>	keys	The keys to use to fetch clients and attempt disconnections asynchronously.

Returns

Type	Description
ValueTask	A Task that represents the asynchronous operation.

DisconnectAsync(TKey)

Disconnects a client from a game instance asynchronously.

Declaration

ValueTask DisconnectAsync(TKey key)

Parameters

Type	Name	Description
TKey	key	The TKey to use to fetch a client and attempt a disconnection.

Returns

Type	Description
ValueTask	A Task that represents the asynchronous operation.