Quantum 3 3.1.0

Public Member Functions | Public Attributes | Properties | List of all members
Photon.Realtime.MatchmakingReconnectInformation Class Reference

Reconnection information storage. Internally runs Set(RealtimeClient, TimeSpan) during MatchmakingExtensions.ConnectToRoomAsync(RealtimeClient, MatchmakingArguments). More...

Inheritance diagram for Photon.Realtime.MatchmakingReconnectInformation:
Quantum.QuantumReconnectInformation

Public Member Functions

virtual void Set (RealtimeClient client)
 Set is called from the matchmaking when the connection has been successful. More...
 
void Set (RealtimeClient client, TimeSpan timeSpan)
 Update all info. More...
 
override string ToString ()
 Print readable information about its fields. More...
 

Public Attributes

string AppVersion
 The app version used in the former connection. More...
 
int DefaultTimeout = 20
 The default timeout that is used when Set(RealtimeClient) is called. More...
 
bool HasTimedOut => Timeout < DateTime.UtcNow
 Checks the timeout and returns false when it ran out. More...
 
string Region
 The region the client was connected to. More...
 
string Room
 The room name the client was connected to. More...
 
long TimeoutInTicks
 The timeout after this information is considered to useable. More...
 
string UserId
 The user id the client used to connect to the server. More...
 

Properties

DateTime Timeout [get, set]
 Set and get TimeoutInTicks. More...
 

Detailed Description

Reconnection information storage. Internally runs Set(RealtimeClient, TimeSpan) during MatchmakingExtensions.ConnectToRoomAsync(RealtimeClient, MatchmakingArguments).

Member Function Documentation

◆ Set() [1/2]

virtual void Photon.Realtime.MatchmakingReconnectInformation.Set ( RealtimeClient  client)
inlinevirtual

Set is called from the matchmaking when the connection has been successful.

Parameters
clientPhoton client object.

Reimplemented in Quantum.QuantumReconnectInformation.

◆ Set() [2/2]

void Photon.Realtime.MatchmakingReconnectInformation.Set ( RealtimeClient  client,
TimeSpan  timeSpan 
)
inline

Update all info.

Parameters
clientPhoton client object.
timeSpanWhen is this data considered be too old to use.

◆ ToString()

override string Photon.Realtime.MatchmakingReconnectInformation.ToString ( )
inline

Print readable information about its fields.

Returns

Member Data Documentation

◆ Room

string Photon.Realtime.MatchmakingReconnectInformation.Room

The room name the client was connected to.

◆ Region

string Photon.Realtime.MatchmakingReconnectInformation.Region

The region the client was connected to.

◆ AppVersion

string Photon.Realtime.MatchmakingReconnectInformation.AppVersion

The app version used in the former connection.

◆ UserId

string Photon.Realtime.MatchmakingReconnectInformation.UserId

The user id the client used to connect to the server.

◆ TimeoutInTicks

long Photon.Realtime.MatchmakingReconnectInformation.TimeoutInTicks

The timeout after this information is considered to useable.

◆ DefaultTimeout

int Photon.Realtime.MatchmakingReconnectInformation.DefaultTimeout = 20

The default timeout that is used when Set(RealtimeClient) is called.

◆ HasTimedOut

bool Photon.Realtime.MatchmakingReconnectInformation.HasTimedOut => Timeout < DateTime.UtcNow

Checks the timeout and returns false when it ran out.

Property Documentation

◆ Timeout

DateTime Photon.Realtime.MatchmakingReconnectInformation.Timeout
getset

Set and get TimeoutInTicks.