Class TestHookGameClient

A test hook game client for testing game client tokens.

Inheritance

object

TestHookGameClient

Implements

IGameConnect

IEquatable<TestHookGameClient>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Phoenix.Aruba.TestTitle

Assembly: Phoenix.Plugin.Aruba.TestTitle.dll

Syntax

public class TestHookGameClient : IGameConnect, IEquatable<TestHookGameClient?>

Remarks

Initializes a new instance of the TestHookGameClient class.

Constructors

TestHookGameClient(IClient<IMessage>)

A test hook game client for testing game client tokens.

Declaration

public TestHookGameClient(IClient<IMessage> channel)

Parameters

Type	Name	Description
IClient<IMessage>	channel	The channel normally used to conenct to a game application.

Remarks

Initializes a new instance of the TestHookGameClient class.

Properties

IsConnected

Gets a value indicating whether the client is connected or not.

Declaration

public bool IsConnected { get; }

Property Value

Type	Description
bool

IsConnecting

Gets a value indicating whether the client is connecting or not.

Declaration

public bool IsConnecting { get; }

Property Value

Type	Description
bool

Name

Gets or sets a name for the client to identify it in log messages.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

Methods

ConnectAsync(CancellationOptions?)

Connects to a game application.

Declaration

public Task ConnectAsync(CancellationOptions? cancellationOptions = null)

Parameters

Type	Name	Description
CancellationOptions?	cancellationOptions	The Microsoft.XboxStudios.Bifrost.CancellationOptions.

Returns

Type	Description
Task	A Task that represents the asynchronous operation.

Disconnect()

Disconnects from a game application synchronously.

Declaration

public void Disconnect()

DisconnectAsync()

Disconnects from a game application asynchronously.

Declaration

public Task DisconnectAsync()

Returns

Type	Description
Task	A Task that represents the asynchronous operation.

Equals(TestHookGameClient?)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(TestHookGameClient? other)

Parameters

Type	Name	Description
TestHookGameClient	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

GetRandomGuidAsString()

Gets a random GUID as a string.

Declaration

public string GetRandomGuidAsString()

Returns

Type	Description
string	A random GUID as a string

Events

ConnectionLostEvent

An event executed when a client loses connection.

Declaration

public event EventHandler? ConnectionLostEvent

Event Type

Type	Description
EventHandler

Implements

Microsoft.XboxStudios.ClientManager.IGameConnect

IEquatable<T>