Inheritance diagram for Photon.LoadBalancing.GameServer.GameClientPeer:

Public Member Functions
	GameClientPeer (InitRequest initRequest, GameApplication application)
	this constructor is called only from self-hosted layer More...

override string	ToString ()

override bool	IsThisSameSession (HivePeer peer)

override void	UpdateSecure (string key, object value)

virtual string	GetRoomCacheDebugString (string gameId)

void	OnAuthTimeout (byte authOpCode)

Public Member Functions inherited from Photon.Hive.HivePeer
	HivePeer (InitRequest request)
	Initializes a new instance of the HivePeer class. More...

bool	ValidateOperation (Operation operation, SendParameters sendParameters)
	Checks if a operation is valid. If the operation is not valid an operation response containing a descriptive error message will be sent to the peer. More...

void	RemovePeerFromCurrentRoom (int reason, string detail)
	Checks if the the state of peer is set to a reference of a room. If a room reference is present the peer will be removed from the related room and the reference will be disposed. Disposing the reference allows the associated room factory to remove the room instance if no more references to the room exists. More...

void	ReleaseRoomReference ()

void	OnJoinFailed (ErrorCode result, string details)

Public Member Functions inherited from Photon.SocketServer.ClientPeer
void	Trace (bool enabled, string tag)

new void	GetTraceStatus (out int traceOptions, out int enableOptions, out string tag)

void	TraceIfEnabledInConnect (string tag)
	Starts tracing if client connected with PeerId 0xFFFE to signal it wants to be traced (e.g. reconnect after an unexpected disconnect) More...

Public Member Functions inherited from Photon.SocketServer.PeerBase
void	Initialize (InitRequest initRequest)

override string	ToString ()

void	Disconnect (int disconnectError=ErrorCodes.Ok)
	Closes the connection. More...

void	AbortConnection ()
	Forces the connection to close immediately. Should only be used if "Disconnect" does not lead to a clean connection shutdown, e.g. in case of an overloaded connection. More...

void	Flush ()
	Flushes all pending data to the socket. More...

byte[]	InitializeEncryption (byte[] otherPartyPublicKey)
	Initializes the peer to receive and send encrypted operations with EncryptionMethod.Sha256Pkcs7. More...

byte[]	InitializeEncryption (byte[] otherPartyPublicKey, EncryptionMethod mode)
	Initializes the peer to receive and send encrypted operations. More...

bool	SetupEncryption (EncryptionData encryptionData, byte channelCount, out short errorCode, out string errorMsg)

SendResult	SendEvent (IEventData eventData, SendParameters sendParameters)
	Sends an IEventData object to the client. More...

SendResult	SendMessage (object message, SendParameters sendParameters)

SendResult	SendOperationResponse (OperationResponse operationResponse, SendParameters sendParameters)
	Sends the operation response to the client. More...

SendResult	SendDisconnectMessage (DisconnectMessage message, SendParameters sendParameters, int disconnectDelay=DefaultDisconnectInterval)

void	GetStats (out int roundTripTime, out int roundTripTimeVariance, out int numFailures)

void	SetDebugString (string message)

string	GetDebugString ()

virtual string	GetHistograms ()

SendResult	SendEventAndDisconnect (IEventData eventData, SendParameters sendParameters, int disconnectDelay=DefaultDisconnectInterval, int disconnectCode=ErrorCodes.Ok)

SendResult	SendMessageAndDisconnect (object message, SendParameters sendParameters, int disconnectDelay=DefaultDisconnectInterval, int disconnectCode=ErrorCodes.Ok)

SendResult	SendOperationResponseAndDisconnect (OperationResponse operationResponse, SendParameters sendParameters, int disconnectDelay=DefaultDisconnectInterval)
	Sends the operation response to the client. More...

void	ScheduleDisconnect (int disconnectError, int delay)
	Schedules disconnect for peer. After this call data will be neither accepted from nor sent to client one of use cases is next: send error info and schedule for disconnect. this will give a chance to error information to reach a client More...

int	GetLastTouch ()

void	SetPrivateCustomTypeCache (CustomTypeCache cache)
	Sets private custom type cache. It is supposed to be used together with plugins. In other case Protocol.TryRegisterCustomType should be used More...

void	SetInboundController (InboundController controller)

void	Dispose ()
	Disposes the peer. More...

void	Trace (bool enabled, object tag)

Public Attributes
IFiber	Fiber => this.RequestFiber

Public Attributes inherited from Photon.Hive.HivePeer
int	JoinStage => this.joinStage

Public Attributes inherited from Photon.SocketServer.PeerBase
bool	Connected => this.ConnectionState == ConnectionState.Connected \|\| this.connectionState == ConnectionState.ScheduledForDisconnect
	Gets a value indicating whether this PeerBase instance is connected. More...

int	ConnectionId => this.UnmanagedPeer.GetConnectionID()
	Gets the connection id. More...

bool	IsConnectionSecure => this.datagramEncryptionUsed \|\| this.NetworkProtocol == NetworkProtocolType.SecureWebSocket

bool	Disposed => this.ConnectionState == ConnectionState.Disposed
	Gets a value indicating whether the peer was disposed. More...

bool	ScheduledForDisconnect => this.connectionState == ConnectionState.ScheduledForDisconnect

IPAddress	LocalIPAddress => string.IsNullOrEmpty(this.LocalIP) ? IPAddress.None : IPAddress.Parse(this.LocalIP)
	Gets the IP Address the client connects to. More...

IPAddress	RemoteIPAddress => string.IsNullOrEmpty(this.RemoteIP) ? IPAddress.None : IPAddress.Parse(this.RemoteIP)
	Gets the client's remote IP address. More...

IFiber	RequestFiber => this.requestFiber
	Gets fiber for incoming messages. More...

bool	LocalIPAddressIsIPv6 => this.LocalIPAddress.AddressFamily == AddressFamily.InterNetworkV6
	If true connection is using a server IPv6 endpoint. More...

bool	IsIPv6ToIPv4Bridged => this.SourceUsingIPv6 && this.LocalIPAddress.AddressFamily != AddressFamily.InterNetworkV6
	If true the client is being bridged (DNS64+NAT64), also SourceUsingIPv6. More...

ProtocolType	ProtocolType => this.protocol.ProtocolType

Protected Member Functions
	GameClientPeer (InitRequest initRequest, GameApplication application, bool derived)

override void	OnRoomNotFound (string gameId)

override void	OnDisconnect (int reasonCode, string reasonDetail)
	The connection was closed. More...

override void	OnOperationRequest (OperationRequest request, SendParameters sendParameters)
	Incoming OperationRequests are handled here. This method is being enqueued on the PeerBase.RequestFiber. More...

override RoomReference	GetOrCreateRoom (string gameId, params object[] args)

override bool	TryCreateRoom (string gameId, out RoomReference roomReference, params object[] args)

override bool	TryGetRoomReference (string gameId, out RoomReference roomReference)

override bool	TryGetRoomWithoutReference (string gameId, out Room room)

virtual void	HandleAuthenticateOperation (OperationRequest operationRequest, SendParameters sendParameters)

void	SetupPeer (string userId)

AuthenticationToken	GetValidAuthToken (AuthenticateRequest authenticateRequest, SendParameters sendParameters)

virtual bool	ValidateAuthToken (AuthenticateRequest authenticateRequest, SendParameters sendParameters, AuthenticationToken authToken, out ErrorCode errorCode, out string errorMsg)

override PluginTraits	GetPluginTraits ()

override void	HandleDebugGameOperation (OperationRequest operationRequest, SendParameters sendParameters)

override void	HandleRaiseEventOperation (OperationRequest operationRequest, SendParameters sendParameters)
	Enqueues RaiseEvent operation requests in the peers current game. More...

override void	HandleCreateGameOperation (OperationRequest operationRequest, SendParameters sendParameters)

virtual object	GetEncryptedAuthToken ()

override bool	MayJoinOrCreateGame (JoinGameRequest joinGameRequest, out short errorCode, out string errorMsg)

virtual bool	ValidateExpectedGame (JoinGameRequest joinRequest)

Protected Member Functions inherited from Photon.Hive.HivePeer
virtual void	HandleSetPropertiesOperation (OperationRequest operationRequest, SendParameters sendParameters)
	Enqueues SetProperties operation requests in the peers current game. More...

virtual void	HandleJoinGameOperation (OperationRequest operationRequest, SendParameters sendParameters)
	Handles the JoinGameRequest to enter a HiveGame. This method removes the peer from any previously joined room, finds the room intended for join and enqueues the operation for it to handle. More...

virtual void	HandleLeaveOperation (OperationRequest operationRequest, SendParameters sendParameters)
	Handles the LeaveRequest to leave a HiveGame. More...

virtual void	HandlePingOperation (OperationRequest operationRequest, SendParameters sendParameters)
	Handles a ping operation. More...

virtual void	HandleRpcOperation (OperationRequest request, SendParameters sendParameters)
	Handles WebRpc operation More...

override void	OnDisconnect (int reasonCode, string reasonDetail)
	Called when client disconnects. Ensures that disconnected players leave the game Room. The player is not removed immediately but a message is sent to the room. This avoids threading issues by making sure the player remove is not done concurrently with operations. More...

override void	OnOperationRequest (OperationRequest operationRequest, SendParameters sendParameters)
	Called when the client sends an OperationRequest. More...

void	HandleUnknownOperationCode (OperationRequest operationRequest, SendParameters sendParameters)

override void	OnDeserializationError (byte[] data, RtsMessageType msgType, string debugMessage, short errorCode=ErrorCodes.UnexpectedData, byte code=0, Exception exception=null)
	This method is called if incoming data has an unexpected format. Per default this method disconnects the client. Override to change this behavior. More...

override void	OnSendBufferFull ()
	A send operation failed because of insufficient buffer space. If this happens there is too much reliable data being sent for the available band width. The client is disconnected per default. Override to change the behavior. More...

override void	OnSendBufferEmpty ()
	The default behavior of OnSendBufferFull is to disconnect the client. If this behavior is changed (override) the inheritor can pause sending until OnSendBufferEmpty is called. More...

Protected Member Functions inherited from Photon.SocketServer.ClientPeer
	ClientPeer (InitRequest initRequest)

Protected Member Functions inherited from Photon.SocketServer.PeerBase
virtual SendResult	SendData (byte[] data, SendParameters sendParameters)
	Sends bytes to the client. More...

virtual void	OnReceive (byte[] data, SendParameters sendParameters)
	Invoked if incoming data was received for the peer. More...

void	OnMessageInternal (object message, SendParameters sendParameters)

void	OnOperationRequestInternal (OperationRequest operationRequest, SendParameters sendParameters)

virtual void	Dispose (bool disposing)
	Disposes the internal fibers. More...

OperationRequest	ParseOperationRequest (byte[] data, SendParameters sendParameters)

OperationRequest	ParseInternalOperationRequest (byte[] data, SendParameters sendParameters)

object	ParseMessage (byte[] data, SendParameters sendParameters)

byte[]	ParseRawMessage (byte[] data, SendParameters sendParameters)

void	HandleParseError (byte[] data, SendParameters sendParameters, Exception exception, string errorMsg, short errorCode, RtsMessageType msgType, byte operationCode=0)

void	GetTraceStatus (out int traceOptions, out int enableOptions, out string tag)

void	DisconnectAfterSend (int disconnectCode, int disconnectDelay, SendResult result)

virtual void	OnEncryptionQueueOverload (EncryptionQueueFailureParams failureParams)

Protected Attributes
readonly bool	binaryTokenUsed

int	NumberAuthRequests

int	MaxNumberAuthRequests = 3

Protected Attributes inherited from Photon.SocketServer.PeerBase
readonly object	SyncRoot = new object()
	object for synchronization More...

CustomTypeCache	privateCustomTypeCache

PeerMetaDataContext	metaDataContext

Static Protected Attributes
static readonly LogCountGuard	canNotDecryptToken = new LogCountGuard(new TimeSpan(0, 1, 0))

Static Protected Attributes inherited from Photon.SocketServer.PeerBase
static readonly ILogger	sendErrorLog = LogManager.GetLogger("Photon.ErrorLog.PeerSendError")

Properties
DateTime	LastActivity `[get, protected set]`

byte	LastOperation `[get, protected set]`

bool	IsAuthenticated `[get, set]`

bool	AllowDebugGameOperation = CommonSettings.Default.AllowDebugGameOperation `[get, set]`

IDisposable	AuthTimeoutTimer `[get, set]`

Properties inherited from Photon.Hive.HivePeer
RoomReference	RoomReference `[get]`
	Gets or sets a Caching.RoomReference when joining a Room. More...

Actor	Actor `[get, set]`

string	UserId `[get, protected set]`

WebRpcHandler	WebRpcHandler `[get, set]`

Dictionary< string, object >	AuthCookie `[get, protected set]`

AuthenticationToken	AuthToken `[get, protected set]`

int	HttpRpcCallsLimit `[get, set]`

int	CheckCount `[get, set]`
	The count of checks which were performed on this peer while it is in invalid state. More...

int	LimitMaxUniqPropertyKeysPerPeer = int.MaxValue `[get, set]`

int	LimitMaxPropertiesSizePerGame = int.MaxValue `[get, set]`

Properties inherited from Photon.SocketServer.PeerBase
ConnectionState	ConnectionState `[get, set]`
	Gets the ConnectionState for this instance. More...

string	LocalIP `[get]`
	Gets the IP the client connects to. More...

int	LocalPort `[get]`
	Gets the port the client connects to. More...

NetworkProtocolType	NetworkProtocol `[get]`
	Gets the network protocol type used by the peer. More...

IRpcProtocol	Protocol `[get, set]`
	Gets the used IRpcProtocol protocol. More...

string	RemoteIP `[get]`
	Gets the client's remote IP address. More...

int	RemotePort `[get]`
	Gets the port the client connects from. More...

int	RoundTripTime `[get, protected set]`
	Gets the last round trip time for this peer. More...

int	RoundTripTimeVariance `[get, protected set]`
	Gets the last round trip time variance for this peer. More...

int	NumFailures `[get, protected set]`

bool	SourceUsingIPv6 `[get]`
	If true the peer is using IPv6 to connect to the server, if the server endpoint used is not IPv6 (LocalIPAddressIsIPv6) it means the client is being bridged (DNS64+NAT64), also IsIPv6ToIPv4Bridged. More...

bool	ClientUsingDebugLib `[get]`

byte	SdkId `[get]`

byte	PlatformId `[get]`

Version	ClientVersion `[get, protected set]`

DateTime	CreationTime = DateTime.Now `[get]`

PeerType	PeerType `[get]`
	Under laying native peer type More...

InboundController	PrivateInboundController `[get]`

int	LastErrorCode `[get]`
	last error code that we was sent/set though this peer More...

Properties inherited from Photon.Common.Authentication.IAuthTimeoutCheckerClient
IDisposable	AuthTimeoutTimer `[get, set]`

IFiber	Fiber `[get]`

Additional Inherited Members
Static Public Attributes inherited from Photon.SocketServer.PeerBase
const int	DefaultDisconnectInterval = 5_000

Static Protected Member Functions inherited from Photon.SocketServer.PeerBase
static bool	NeedSendErrorLog (SendResult sendResult)

Constructor & Destructor Documentation

◆ GameClientPeer() [1/2]

Photon.LoadBalancing.GameServer.GameClientPeer.GameClientPeer	(	InitRequest	initRequest,
		GameApplication	application
	)

inline

this constructor is called only from self-hosted layer

Parameters

initRequest
application

◆ GameClientPeer() [2/2]

Photon.LoadBalancing.GameServer.GameClientPeer.GameClientPeer	(	InitRequest	initRequest,
		GameApplication	application,
		bool	derived
	)

inlineprotected

Member Function Documentation

◆ GetEncryptedAuthToken()

virtual object Photon.LoadBalancing.GameServer.GameClientPeer.GetEncryptedAuthToken ( )

inlineprotectedvirtual

◆ GetOrCreateRoom()

override RoomReference Photon.LoadBalancing.GameServer.GameClientPeer.GetOrCreateRoom	(	string	gameId,
		params object[]	args
	)

inlineprotectedvirtual

Reimplemented from Photon.Hive.HivePeer.

◆ GetPluginTraits()

override PluginTraits Photon.LoadBalancing.GameServer.GameClientPeer.GetPluginTraits ( )

inlineprotectedvirtual

Reimplemented from Photon.Hive.HivePeer.

◆ GetRoomCacheDebugString()

virtual string Photon.LoadBalancing.GameServer.GameClientPeer.GetRoomCacheDebugString ( string gameId )

inlinevirtual

◆ GetValidAuthToken()

AuthenticationToken Photon.LoadBalancing.GameServer.GameClientPeer.GetValidAuthToken	(	AuthenticateRequest	authenticateRequest,
		SendParameters	sendParameters
	)

inlineprotected

◆ HandleAuthenticateOperation()

virtual void Photon.LoadBalancing.GameServer.GameClientPeer.HandleAuthenticateOperation	(	OperationRequest	operationRequest,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

◆ HandleCreateGameOperation()

override void Photon.LoadBalancing.GameServer.GameClientPeer.HandleCreateGameOperation	(	OperationRequest	operationRequest,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

Reimplemented from Photon.Hive.HivePeer.

◆ HandleDebugGameOperation()

override void Photon.LoadBalancing.GameServer.GameClientPeer.HandleDebugGameOperation	(	OperationRequest	operationRequest,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

Reimplemented from Photon.Hive.HivePeer.

◆ HandleRaiseEventOperation()

override void Photon.LoadBalancing.GameServer.GameClientPeer.HandleRaiseEventOperation	(	OperationRequest	operationRequest,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

Enqueues RaiseEvent operation requests in the peers current game.

Parameters

operationRequest	The operation request.
sendParameters	The send Parameters.

The current for a peer is stored in the peers state property. Using the Room.EnqueueOperation method ensures that all operation request dispatch logic has thread safe access to all room instance members since they are processed in a serial order.

Inheritors can use this method to enqueue there custom game operation to the peers current game.

Reimplemented from Photon.Hive.HivePeer.

◆ IsThisSameSession()

override bool Photon.LoadBalancing.GameServer.GameClientPeer.IsThisSameSession ( HivePeer peer )

inlinevirtual

Reimplemented from Photon.Hive.HivePeer.

◆ MayJoinOrCreateGame()

override bool Photon.LoadBalancing.GameServer.GameClientPeer.MayJoinOrCreateGame	(	JoinGameRequest	joinGameRequest,
		out short	errorCode,
		out string	errorMsg
	)

inlineprotectedvirtual

Reimplemented from Photon.Hive.HivePeer.

◆ OnAuthTimeout()

void Photon.LoadBalancing.GameServer.GameClientPeer.OnAuthTimeout ( byte authOpCode )

inline

Implements Photon.Common.Authentication.IAuthTimeoutCheckerClient.

◆ OnDisconnect()

override void Photon.LoadBalancing.GameServer.GameClientPeer.OnDisconnect	(	int	reasonCode,
		string	reasonDetail
	)

inlineprotectedvirtual

The connection was closed.

Implements Photon.SocketServer.PeerBase.

◆ OnOperationRequest()

override void Photon.LoadBalancing.GameServer.GameClientPeer.OnOperationRequest	(	OperationRequest	operationRequest,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

Incoming OperationRequests are handled here. This method is being enqueued on the PeerBase.RequestFiber.

Parameters

operationRequest	The operation Request.
sendParameters	The send parameters.

Implements Photon.SocketServer.PeerBase.

◆ OnRoomNotFound()

override void Photon.LoadBalancing.GameServer.GameClientPeer.OnRoomNotFound ( string gameId )

inlineprotectedvirtual

Reimplemented from Photon.Hive.HivePeer.

◆ SetupPeer()

void Photon.LoadBalancing.GameServer.GameClientPeer.SetupPeer ( string userId )

inlineprotected

◆ ToString()

override string Photon.LoadBalancing.GameServer.GameClientPeer.ToString ( )

inline

◆ TryCreateRoom()

override bool Photon.LoadBalancing.GameServer.GameClientPeer.TryCreateRoom	(	string	gameId,
		out RoomReference	roomReference,
		params object[]	args
	)

inlineprotectedvirtual

Reimplemented from Photon.Hive.HivePeer.

◆ TryGetRoomReference()

override bool Photon.LoadBalancing.GameServer.GameClientPeer.TryGetRoomReference	(	string	gameId,
		out RoomReference	roomReference
	)

inlineprotectedvirtual

Reimplemented from Photon.Hive.HivePeer.

◆ TryGetRoomWithoutReference()

override bool Photon.LoadBalancing.GameServer.GameClientPeer.TryGetRoomWithoutReference	(	string	gameId,
		out Room	room
	)

inlineprotectedvirtual

Reimplemented from Photon.Hive.HivePeer.

◆ UpdateSecure()

override void Photon.LoadBalancing.GameServer.GameClientPeer.UpdateSecure	(	string	key,
		object	value
	)

inlinevirtual

Reimplemented from Photon.Hive.HivePeer.

◆ ValidateAuthToken()

virtual bool Photon.LoadBalancing.GameServer.GameClientPeer.ValidateAuthToken	(	AuthenticateRequest	authenticateRequest,
		SendParameters	sendParameters,
		AuthenticationToken	authToken,
		out ErrorCode	errorCode,
		out string	errorMsg
	)

inlineprotectedvirtual

◆ ValidateExpectedGame()

virtual bool Photon.LoadBalancing.GameServer.GameClientPeer.ValidateExpectedGame ( JoinGameRequest joinRequest )

inlineprotectedvirtual

Member Data Documentation

◆ binaryTokenUsed

readonly bool Photon.LoadBalancing.GameServer.GameClientPeer.binaryTokenUsed

protected

◆ canNotDecryptToken

readonly LogCountGuard Photon.LoadBalancing.GameServer.GameClientPeer.canNotDecryptToken = new LogCountGuard(new TimeSpan(0, 1, 0))

staticprotected

◆ Fiber

IFiber Photon.LoadBalancing.GameServer.GameClientPeer.Fiber => this.RequestFiber

◆ MaxNumberAuthRequests

int Photon.LoadBalancing.GameServer.GameClientPeer.MaxNumberAuthRequests = 3

protected

◆ NumberAuthRequests

int Photon.LoadBalancing.GameServer.GameClientPeer.NumberAuthRequests

protected

Property Documentation

◆ AllowDebugGameOperation

bool Photon.LoadBalancing.GameServer.GameClientPeer.AllowDebugGameOperation = CommonSettings.Default.AllowDebugGameOperation

getsetprotected

◆ AuthTimeoutTimer

IDisposable Photon.LoadBalancing.GameServer.GameClientPeer.AuthTimeoutTimer

getset

◆ IsAuthenticated

bool Photon.LoadBalancing.GameServer.GameClientPeer.IsAuthenticated

getsetprotected

◆ LastActivity

DateTime Photon.LoadBalancing.GameServer.GameClientPeer.LastActivity

getprotected set

◆ LastOperation

byte Photon.LoadBalancing.GameServer.GameClientPeer.LastOperation

getprotected set

Photon Server API Documentation v5.0RC1

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Properties

Additional Inherited Members

Constructor & Destructor Documentation

◆ GameClientPeer() [1/2]

◆ GameClientPeer() [2/2]

Member Function Documentation

◆ GetEncryptedAuthToken()

◆ GetOrCreateRoom()

◆ GetPluginTraits()

◆ GetRoomCacheDebugString()

◆ GetValidAuthToken()

◆ HandleAuthenticateOperation()

◆ HandleCreateGameOperation()

◆ HandleDebugGameOperation()

◆ HandleRaiseEventOperation()

◆ IsThisSameSession()

◆ MayJoinOrCreateGame()

◆ OnAuthTimeout()

◆ OnDisconnect()

◆ OnOperationRequest()

◆ OnRoomNotFound()

◆ SetupPeer()

◆ ToString()

◆ TryCreateRoom()

◆ TryGetRoomReference()

◆ TryGetRoomWithoutReference()

◆ UpdateSecure()

◆ ValidateAuthToken()

◆ ValidateExpectedGame()

Member Data Documentation

◆ binaryTokenUsed

◆ canNotDecryptToken

◆ Fiber

◆ MaxNumberAuthRequests

◆ NumberAuthRequests

Property Documentation

◆ AllowDebugGameOperation

◆ AuthTimeoutTimer

◆ IsAuthenticated

◆ LastActivity

◆ LastOperation