Inheritance diagram for Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer:

Public Member Functions
	IncomingGameServerPeer (InitRequest initRequest, MasterApplication masterApplication)

override string	ToString ()

object	GetRegisterResponse ()

Public Member Functions inherited from Photon.SocketServer.ServerToServer.S2SPeerBase
SendResult	InitializeEncryption ()
	Initializes the peer to receive and send encrypted operations. More...

SendResult	SendOperationRequest (OperationRequest operationRequest, SendParameters sendParameters)
	Sends an operation request. More...

SendResult	SendOperationRequestAndDisconnect (OperationRequest operationRequest, SendParameters sendParameters, int disconnectDelay=DefaultDisconnectInterval, int disconnectError=ErrorCodes.Ok)

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 Member Functions inherited from Photon.LoadBalancing.MasterServer.GameServer.IGameServerPeer
void	Disconnect (int disconnectError)

Public Attributes
bool	IsRegistered => !string.IsNullOrEmpty(this.ServerId)

string	Name => "s2s GS connection"

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
virtual void	OnContextAttached ()

virtual void	OnContextDettached ()

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

override void	OnEvent (IEventData eventData, SendParameters sendParameters)
	Called when an EventData was received. More...

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

override void	OnOperationResponse (OperationResponse operationResponse, SendParameters sendParameters)
	Called when an OperationResponse was received. 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...

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

	InboundS2SPeer (InitResponse response)

Protected Member Functions inherited from Photon.SocketServer.ServerToServer.S2SPeerBase
	S2SPeerBase (InitResponse response)
	Initializes a new instance of the S2SPeerBase class. More...

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

virtual void	OnDisconnectMessage (DisconnectMessage message)

virtual void	OnInitializeEcryptionCompleted (short resultCode, string debugMessage)
	Invoked if an initialize encryption request was completed. More...

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

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

void	OnMessageInternal (object message, SendParameters sendParameters)

void	OnOperationRequestInternal (OperationRequest operationRequest, SendParameters sendParameters)

virtual 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...

virtual void	OnDeserializationError (byte[] data, RtsMessageType msgType, string debugMessage, short errorCode=ErrorCodes.UnexpectedData, byte opCode=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...

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)

Properties
string	ServerId `[get, set]`

GameServerContext	Context `[get]`

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.LoadBalancing.MasterServer.GameServer.IGameServerPeer
IRpcProtocol	Protocol `[get]`

IFiber	RequestFiber `[get]`

string	RemoteIP `[get]`

int	RemotePort `[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)

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

CustomTypeCache	privateCustomTypeCache

PeerMetaDataContext	metaDataContext

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

Constructor & Destructor Documentation

◆ IncomingGameServerPeer()

Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.IncomingGameServerPeer	(	InitRequest	initRequest,
		MasterApplication	masterApplication
	)

inline

Member Function Documentation

◆ GetRegisterResponse()

object Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.GetRegisterResponse ( )

inline

◆ OnContextAttached()

virtual void Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.OnContextAttached ( )

inlineprotectedvirtual

◆ OnContextDettached()

virtual void Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.OnContextDettached ( )

inlineprotectedvirtual

◆ OnDisconnect()

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

inlineprotectedvirtual

The connection was closed.

Implements Photon.SocketServer.PeerBase.

◆ OnEvent()

override void Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.OnEvent	(	IEventData	eventData,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

Called when an EventData was received.

Parameters

eventData	The event data.
sendParameters	The send Parameters.

Implements Photon.SocketServer.ServerToServer.S2SPeerBase.

◆ OnOperationRequest()

override void Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.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.

◆ OnOperationResponse()

override void Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.OnOperationResponse	(	OperationResponse	operationResponse,
		SendParameters	sendParameters
	)

inlineprotectedvirtual

Called when an OperationResponse was received.

Parameters

operationResponse	The operation response.
sendParameters	The send Parameters.

Implements Photon.SocketServer.ServerToServer.S2SPeerBase.

◆ OnSendBufferFull()

override void Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.OnSendBufferFull ( )

inlineprotectedvirtual

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.

Reimplemented from Photon.SocketServer.PeerBase.

◆ ToString()

override string Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.ToString ( )

inline

Member Data Documentation

◆ IsRegistered

bool Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.IsRegistered => !string.IsNullOrEmpty(this.ServerId)

◆ Name

string Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.Name => "s2s GS connection"

Property Documentation

◆ Context

GameServerContext Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.Context

get

◆ ServerId

string Photon.LoadBalancing.MasterServer.GameServer.IncomingGameServerPeer.ServerId

getsetprotected

Photon Server API Documentation v5.0RC1

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Additional Inherited Members

Constructor & Destructor Documentation

◆ IncomingGameServerPeer()

Member Function Documentation

◆ GetRegisterResponse()

◆ OnContextAttached()

◆ OnContextDettached()

◆ OnDisconnect()

◆ OnEvent()

◆ OnOperationRequest()

◆ OnOperationResponse()

◆ OnSendBufferFull()

◆ ToString()

Member Data Documentation

◆ IsRegistered

◆ Name

Property Documentation

◆ Context

◆ ServerId