Class PhoenixClientManagerAdapter<TClient, TClientOptions>
The base Phoenix client manager adapter.
Inheritance
Inherited Members
Namespace: Phoenix.ClientManager
Assembly: Phoenix.ClientManager.dll
Syntax
public sealed class PhoenixClientManagerAdapter<TClient, TClientOptions> : ClientManagerAdapterBase<IDevice, TClient>, IPhoenixClientManagerAdapter<TClient>, IClientManagerAdapter<IDevice, TClient> where TClient : class, IGameConnectType Parameters
| Name | Description |
|---|---|
| TClient | The client to use. |
| TClientOptions | The configuration options for the channel. |
Remarks
Initializes a new instance of the PhoenixClientManagerAdapter<TClient, TClientOptions> class.
Constructors
View SourcePhoenixClientManagerAdapter(IClientFactory<TClient, TClientOptions>, IPhoenixLogger, IPhoenixClientManagerAdapterConfig<TClientOptions>)
The base Phoenix client manager adapter.
Declaration
public PhoenixClientManagerAdapter(IClientFactory<TClient, TClientOptions> clientFactory, IPhoenixLogger logger, IPhoenixClientManagerAdapterConfig<TClientOptions> config)Parameters
| Type | Name | Description |
|---|---|---|
| IClientFactory<TClient, TClientOptions> | clientFactory | The factory to create clients. |
| IPhoenixLogger | logger | The phoenix logger. |
| IPhoenixClientManagerAdapterConfig<TClientOptions> | config | The configuration of PhoenixClientManagerAdapter<TClient, TClientOptions>. |
Remarks
Initializes a new instance of the PhoenixClientManagerAdapter<TClient, TClientOptions> class.
Methods
View SourceCreateFor(IDevice)
Gets the client for a specific Microsoft.XboxStudios.DeviceConsole.IDevice.
Declaration
public override TClient? CreateFor(IDevice key)Parameters
| Type | Name | Description |
|---|---|---|
| IDevice | key | The key to use. |
Returns
| Type | Description |
|---|---|
| TClient | The client assosciated with the requested key. |
Overrides
View SourceLogException(TClient?, Exception)
A log method used to log exceptions when connecting or disconnecting clients.
Declaration
public override void LogException(TClient? client, Exception e)Parameters
| Type | Name | Description |
|---|---|---|
| TClient | client | The client that experienced the exception. |
| Exception | e | The exception that was thrown. |
Overrides
View SourceOptionsFor(IDevice)
Gets the connection options for a specific device.
Declaration
public object OptionsFor(IDevice device)Parameters
| Type | Name | Description |
|---|---|---|
| IDevice | device | The device to get the options for. |
Returns
| Type | Description |
|---|---|
| object | The connection options. |
SetOptionsFor(IDevice, object)
Sets the options for a given device.
Declaration
public void SetOptionsFor(IDevice device, object options)Parameters
| Type | Name | Description |
|---|---|---|
| IDevice | device | The device to set options for. |
| object | options | The options to set. |