Quantum 3 3.1.0

Static Public Member Functions | List of all members
Photon.Realtime.MatchmakingExtensions Class Reference

An extension class to wrap some of the most common Photon matchmaking calls. More...

Static Public Member Functions

static Task< RealtimeClient > ConnectToRoomAsync (MatchmakingArguments arguments, RealtimeClient client=null)
 
static Task< RealtimeClient > ConnectToRoomAsync (this RealtimeClient client, MatchmakingArguments arguments)
 Run the Photon connection logic to connect to a game server and enter a room. This method only returns after successfully entered a room. This method throws an exception on any errors. More...
 
static Task< RealtimeClient > ReconnectToRoomAsync (MatchmakingArguments arguments, RealtimeClient client=null)
 
static Task< RealtimeClient > ReconnectToRoomAsync (this RealtimeClient client, MatchmakingArguments arguments)
 Run different Photon reconnection logic to reconnect to a game server and re-enter a room. Requires MatchmakingReconnectInformation to be initialized. Different reconnection strategies are applied to rejoin a room. Also works after an app restart if the ReconnectInformation is correctly set up. This method only returns after successfully re-entered the room. This method throws an exception on any errors. More...
 

Detailed Description

An extension class to wrap some of the most common Photon matchmaking calls.

Member Function Documentation

◆ ConnectToRoomAsync()

static Task<RealtimeClient> Photon.Realtime.MatchmakingExtensions.ConnectToRoomAsync ( this RealtimeClient  client,
MatchmakingArguments  arguments 
)
inlinestatic

Run the Photon connection logic to connect to a game server and enter a room. This method only returns after successfully entered a room. This method throws an exception on any errors.

Parameters
clientOptionally client object to start the matchmaking with. Can be null.
argumentsPhoton matchmaking arguments.
Returns
Client connection object that is connected to a Photon room
Exceptions
ArgumentExceptionArguments were incomplete.
DisconnectExceptionIs thrown when the connection terminated.
AuthenticationFailedExceptionIs thrown when the authentication failed.
OperationStartExceptionIs thrown when the operation could not be started.
OperationExceptionIs thrown when the operation completed unsuccessfully.
OperationTimeoutExceptionIs thrown when the operation timed out.
OperationCanceledExceptionIs thrown when the operation have been canceled (AsyncConfig.CancellationSource).

◆ ReconnectToRoomAsync()

static Task<RealtimeClient> Photon.Realtime.MatchmakingExtensions.ReconnectToRoomAsync ( this RealtimeClient  client,
MatchmakingArguments  arguments 
)
inlinestatic

Run different Photon reconnection logic to reconnect to a game server and re-enter a room. Requires MatchmakingReconnectInformation to be initialized. Different reconnection strategies are applied to rejoin a room. Also works after an app restart if the ReconnectInformation is correctly set up. This method only returns after successfully re-entered the room. This method throws an exception on any errors.

Parameters
clientOptionally client object to start the matchmaking with. Can be null.
argumentsPhoton matchmaking arguments.
Returns
Client connection object that is connected to a Photon room
Exceptions
ArgumentExceptionArguments were incomplete, reconnection information not set or invalid.
DisconnectExceptionIs thrown when the connection terminated.
AuthenticationFailedExceptionIs thrown when the authentication failed.
OperationStartExceptionIs thrown when the operation could not be started.
OperationExceptionIs thrown when the operation completed unsuccessfully.
OperationTimeoutExceptionIs thrown when the operation timed out.
OperationCanceledExceptionIs thrown when the operation have been canceled (AsyncConfig.CancellationSource).