Interface IGameConnect

Defines methods to connect to a game application.

Namespace: Microsoft.XboxStudios.ClientManager

Assembly: ClientManager.dll

Syntax

public interface IGameConnect

Properties

IsConnected

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

Declaration

bool IsConnected { get; }

Property Value

Type	Description
bool

IsConnecting

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

Declaration

bool IsConnecting { get; }

Property Value

Type	Description
bool

Name

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

Declaration

string Name { get; set; }

Property Value

Type	Description
string

Methods

ConnectAsync(CancellationOptions?)

Connects to a game application.

Declaration

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

void Disconnect()

DisconnectAsync()

Disconnects from a game application asynchronously.

Declaration

Task DisconnectAsync()

Returns

Type	Description
Task	A Task that represents the asynchronous operation.

Events

ConnectionLostEvent

An event executed when a client loses connection.

Declaration

event EventHandler ConnectionLostEvent

Event Type

Type	Description
EventHandler