Inheritance diagram for Photon.LoadBalancing.GameServer.GameApplication:

Public Member Functions
	GameApplication ()

	GameApplication (IConfiguration configuration)

virtual void	OnMasterConnectionEstablished (MasterServerConnectionBase masterServerConnectionBase)

virtual void	OnMasterConnectionFailed (MasterServerConnectionBase masterServerConnection)

virtual void	OnDisconnectFromMaster (MasterServerConnectionBase masterServerConnection)

CustomTypeCache	GetS2SCustomTypeCache ()

virtual void	OnRegisteredAtMaster (MasterServerConnectionBase masterServerConnectionBase, RegisterGameServerResponse registerResponse)

Public Member Functions inherited from Photon.SocketServer.ApplicationBase
void	BroadCastEvent< TPeer > (IEventData eventData, IEnumerable< TPeer > peers, SendParameters sendParameters)
	Sends an event to a list of peers. This method serializes the data just once per protocol instead of once per peer. More...

bool	ConnectToServerTcp (IPEndPoint remoteEndPoint, string applicationName, object state)
	Establishes a TCP connection between two Photon instances. CreateServerPeer is called once the connection is established. OnServerConnectionFailed is called if the connection fails. More...

bool	ConnectToServerTcp (IPEndPoint remoteEndPoint, string applicationName, object state, IRpcProtocol protocol)
	Establishes a TCP connection between two Photon instances. CreateServerPeer is called once the connection is established. OnServerConnectionFailed is called if the connection fails. More...

bool	ConnectToServerMuxTcp (IPEndPoint remoteEndPoint, string applicationName, object state)
	Establishes a logical, multiplexed TCP connection between two Photon instances. Multiple logical connections are sharing a single physical connection. CreateServerPeer is called once a logical connection is established. OnServerConnectionFailed is called if the logical connection fails. If a phyiscal connection exists when ConnectToServerMuxTcp is called, it is used; otherwise a physical connection is established. If the physical connection is aborted, all logical connections are aborted as well. More...

bool	ConnectToServerUdp (IPEndPoint remoteEndPoint, string applicationName, object state, byte numChannels, short? mtu, Version clientVersion=null)
	Establishes an UDP connection between two Photon instances. CreateServerPeer is called once the connection is established. OnServerConnectionFailed is called if the connection fails. More...

bool	ConnectToServerWebSocketHixie76 (IPEndPoint remoteEndPoint, string applicationName, object state, string origin)
	Establishes an WebSocket connection between two Photon instances, using the Hixie76 WebSocket protocol. CreateServerPeer is called once the connection is established. OnServerConnectionFailed is called if the connection fails. More...

bool	ConnectToServerWebSocket (IPEndPoint remoteEndPoint, string applicationName, object state, WebSocketVersion webSocketVersion, IRpcProtocol protocol)
	Establishes an WebSocket connection between two Photon instances. CreateServerPeer is called once the connection is established. OnServerConnectionFailed is called if the connection fails. More...

bool	ConnectToServerWebRTC (IPEndPoint remoteEndPoint, string applicationName, object state, IRpcProtocol protocol)

bool	ConnectToServer (IPEndPoint remoteEndPoint, string applicationName, object state)
	This method overload is obsolete; use ConnectToServerTcp. More...

bool	ConnectToServer (IPEndPoint remoteEndPoint, bool useMux, string applicationName, object state)
	This method overload is obsolete; use ConnectToServerMuxTcp. More...

bool	ConnectToServer (IPEndPoint remoteEndPoint, string applicationName, object state, IRpcProtocol protocol)
	This method overload is obsolete; use ConnectToServerTcp. More...

bool	ConnectToServer (IPEndPoint remoteEndPoint, string applicationName, object state, byte numChannels, short? mtu, Version clientVersion=null)
	This method overload is obsolete; use ConnectToServerUdp. More...

void	BroadcastMessage< TPeer > (object message, IEnumerable< TPeer > peers, SendParameters sendParameters)

string[]	ListenerList (out ListenerStatus[] status)

bool	ListenerStart (string name)

bool	ListenerStop (string name)

bool	AddRestRequestHandler (string path, RestRequestHandler handler)

bool	RemoveRestRequestHandler (string path)

void	InitCorePerformanceCounters ()

void	OnWebRTCConnectionEstablished (IPhotonWebRTCPeer peer, byte maxChannelCount, uint flags)

void	OnWebRTCChannelConnected (IPhotonWebRTCPeer peer, object userData, byte channelId, ChannelType ChannelType, bool unordered, ushort priority, uint reliability, string label, string protocol)

virtual void	OnWebRTCChannelDestroyed (IPhotonWebRTCPeer peer, object userData, byte channelId)

void	OnOutboundWebRTCConnectionEstablished (IPhotonWebRTCPeer peer, object userData, byte maxChannelCount, uint flags)

void	OnOutboundWebRTCConnectionFailed (object userData, uint errorCode)

IPhotonApplication	OnStart (string instanceName, string applicationName, IPhotonApplicationSink sink, IControlListeners listenerControl, ILogToUnmanagedLog unmanagedLog, IPhotonApplicationsCounter applicationsCounter, string unmanagedLogDirectory)
	Called when the application is started. This method calls Setup. More...

Protected Member Functions
virtual AuthTokenFactory	GetAuthTokenFactory ()

virtual void	CheckGames ()
	Sanity check to verify that game states are cleaned up correctly More...

virtual PeerBase	CreateGamePeer (InitRequest initRequest)

override PeerBase	CreatePeer (InitRequest initRequest)
	This method is called by the IPhotonApplication.OnInit implementation of this class. The inheritor should return a PeerBase implementation. More...

virtual void	InitLogging ()

override void	OnStopRequested ()
	Called when photon stops application domain More...

override void	Setup ()
	This method is called when the current application has been started. The inheritor can setup log4net here and execute other initialization routines here. More...

virtual void	Initialize ()
	we put here stuff that should be initialized only for self hosted More...

virtual void	SetupMasterConnection ()

virtual void	InitGameCache ()
	We need this method here to gracefully skip game cache initialization in descendants More...

override void	TearDown ()
	This method is called when the current application is being stopped. The inheritor can execute cleanup routines here. More...

virtual void	OnNewServerState (ServerState oldState, ServerState requestedState, TimeSpan offlineTime)

virtual void	RaiseOfflineEvent (TimeSpan time)

Protected Member Functions inherited from Photon.SocketServer.ApplicationBase
	ApplicationBase (IConfiguration configuration)
	Initializes a new instance of the ApplicationBase class. More...

virtual IFiber	CreatePeerFiber (InitRequest request)

virtual object	DecryptAuthToken (InitRequest initRequest, byte[] authToken, int offset, int length, out Dictionary< byte, object > encryptionData, out string errorMsg)

virtual void	OnServerConnectionFailed (int errorCode, string errorMessage, object state)
	Invoked if a connection attempt to a server fails. More...

Protected Attributes
PoolFiber	executionFiber

Properties
Guid	ServerId `[get]`

int?	GamingTcpPort `[get, protected set]`

int?	GamingUdpPort `[get, protected set]`

int?	GamingWebSocketPort `[get, protected set]`

int?	GamingSecureWebSocketPort `[get, set]`

string	GamingWsPath `[get, protected set]`

int?	GamingWebRTCPort `[get, protected set]`

IPEndPoint	MasterEndPoint `[get, protected set]`

ApplicationStatsPublisher	AppStatsPublisher `[get, protected set]`

MasterServerConnection	MasterServerConnection `[get, protected set]`

IPAddress	PublicIpAddress `[get, protected set]`

IPAddress	PublicIpAddressIPv6 `[get, protected set]`

WorkloadController	WorkloadController `[get, protected set]`

virtual GameCache	GameCache `[get, protected set]`

AuthTokenFactory	TokenCreator `[get, protected set]`

S2SCustomTypeCacheMan	S2SCacheMan `[get, protected set]`

int	ConnectRetryIntervalSeconds `[get, set]`

bool	IsMaster `[get, set]`

GameUpdatesBatcher	GameUpdatesBatcher `[get]`

ServerState	ServerState `[get]`

Properties inherited from Photon.SocketServer.ApplicationBase
IConfiguration	Configuration `[get, protected set]`
	Configuration loaded by descendants More...

static ApplicationBase	Instance `[get]`
	Gets the application instance. More...

string	ApplicationName `[get]`
	Gets the application name set in PhotonServer.config. More...

string	ApplicationPath `[get]`
	Gets the application path set in PhotonServer.config. More...

string	ApplicationRootPath `[get]`
	Gets the path of the application root path - base location of all applications. More...

string	BinaryPath `[get]`
	Gets the path of the application binaries. More...

int	PeerCount `[get]`
	Gets the number of peers currently connected to the application. More...

string	PhotonInstanceName `[get]`
	Gets the name of the photon instance. More...

bool	Running `[get]`
	Gets a value indicating whether the application is running (the time between Setup and OnStopRequested). More...

string	HwId `[get]`

string	UnmanagedLogPath `[get]`
	Gets the log path of Photon. More...

Version	CoreVersion `[get]`
	Gets Photon Native Core version (PhotonSocketServer.exe). More...

Version	SdkVersion `[get]`
	Gets Photon Managed Core version (SDK). More...

int	EncrptionQueueLimit `[get, set]`

bool	UseEncryptionQueue `[get, set]`

Additional Inherited Members
Static Public Member Functions inherited from Photon.SocketServer.ApplicationBase
static T	GetConfigSectionAndValidate< T > (string path)

Constructor & Destructor Documentation

◆ GameApplication() [1/2]

Photon.LoadBalancing.GameServer.GameApplication.GameApplication ( )

inline

◆ GameApplication() [2/2]

Photon.LoadBalancing.GameServer.GameApplication.GameApplication ( IConfiguration configuration )

inline

Member Function Documentation

◆ CheckGames()

virtual void Photon.LoadBalancing.GameServer.GameApplication.CheckGames ( )

inlineprotectedvirtual

Sanity check to verify that game states are cleaned up correctly

◆ CreateGamePeer()

virtual PeerBase Photon.LoadBalancing.GameServer.GameApplication.CreateGamePeer ( InitRequest initRequest )

inlineprotectedvirtual

◆ CreatePeer()

override PeerBase Photon.LoadBalancing.GameServer.GameApplication.CreatePeer ( InitRequest initRequest )

inlineprotectedvirtual

This method is called by the IPhotonApplication.OnInit implementation of this class. The inheritor should return a PeerBase implementation.

Parameters

initRequest The initialization request.

Returns: A new instance of PeerBase or null.

Implements Photon.SocketServer.ApplicationBase.

◆ GetAuthTokenFactory()

virtual AuthTokenFactory Photon.LoadBalancing.GameServer.GameApplication.GetAuthTokenFactory ( )

inlineprotectedvirtual

◆ GetS2SCustomTypeCache()

CustomTypeCache Photon.LoadBalancing.GameServer.GameApplication.GetS2SCustomTypeCache ( )

inline

◆ InitGameCache()

virtual void Photon.LoadBalancing.GameServer.GameApplication.InitGameCache ( )

inlineprotectedvirtual

We need this method here to gracefully skip game cache initialization in descendants

◆ Initialize()

virtual void Photon.LoadBalancing.GameServer.GameApplication.Initialize ( )

inlineprotectedvirtual

we put here stuff that should be initialized only for self hosted

◆ InitLogging()

virtual void Photon.LoadBalancing.GameServer.GameApplication.InitLogging ( )

inlineprotectedvirtual

◆ OnDisconnectFromMaster()

virtual void Photon.LoadBalancing.GameServer.GameApplication.OnDisconnectFromMaster ( MasterServerConnectionBase masterServerConnection )

inlinevirtual

◆ OnMasterConnectionEstablished()

virtual void Photon.LoadBalancing.GameServer.GameApplication.OnMasterConnectionEstablished ( MasterServerConnectionBase masterServerConnectionBase )

inlinevirtual

◆ OnMasterConnectionFailed()

virtual void Photon.LoadBalancing.GameServer.GameApplication.OnMasterConnectionFailed ( MasterServerConnectionBase masterServerConnection )

inlinevirtual

◆ OnNewServerState()

virtual void Photon.LoadBalancing.GameServer.GameApplication.OnNewServerState	(	ServerState	oldState,
		ServerState	requestedState,
		TimeSpan	offlineTime
	)

inlineprotectedvirtual

◆ OnRegisteredAtMaster()

virtual void Photon.LoadBalancing.GameServer.GameApplication.OnRegisteredAtMaster	(	MasterServerConnectionBase	masterServerConnectionBase,
		RegisterGameServerResponse	registerResponse
	)

inlinevirtual

◆ OnStopRequested()

override void Photon.LoadBalancing.GameServer.GameApplication.OnStopRequested ( )

inlineprotectedvirtual

Called when photon stops application domain

Reimplemented from Photon.SocketServer.ApplicationBase.

◆ RaiseOfflineEvent()

virtual void Photon.LoadBalancing.GameServer.GameApplication.RaiseOfflineEvent ( TimeSpan time )

inlineprotectedvirtual

◆ Setup()

override void Photon.LoadBalancing.GameServer.GameApplication.Setup ( )

inlineprotectedvirtual

This method is called when the current application has been started. The inheritor can setup log4net here and execute other initialization routines here.

log4net initialization:

private static readonly ILogger log = LogManager.GetCurrentClassLogger();
protected override void Setup()
{
// configure log4net with a config file
var configFileInfo = new FileInfo(Path.Combine(this.BinaryPath, "log4net.config"));
XmlConfigurator.ConfigureAndWatch(configFileInfo);
 
// redirect photon sdk internal logging to log4net
ExitGames.Logging.LogManager.SetLoggerFactory(ExitGames.Logging.Log4Net.Log4NetLoggerFactory.Instance);
}

Implements Photon.SocketServer.ApplicationBase.

◆ SetupMasterConnection()

virtual void Photon.LoadBalancing.GameServer.GameApplication.SetupMasterConnection ( )

inlineprotectedvirtual

◆ TearDown()

override void Photon.LoadBalancing.GameServer.GameApplication.TearDown ( )

inlineprotectedvirtual

This method is called when the current application is being stopped. The inheritor can execute cleanup routines here.

Implements Photon.SocketServer.ApplicationBase.

Member Data Documentation

◆ executionFiber

PoolFiber Photon.LoadBalancing.GameServer.GameApplication.executionFiber

protected

Property Documentation

◆ AppStatsPublisher

ApplicationStatsPublisher Photon.LoadBalancing.GameServer.GameApplication.AppStatsPublisher

getprotected set

◆ ConnectRetryIntervalSeconds

int Photon.LoadBalancing.GameServer.GameApplication.ConnectRetryIntervalSeconds

getset

◆ GameCache

virtual GameCache Photon.LoadBalancing.GameServer.GameApplication.GameCache

getprotected set

◆ GameUpdatesBatcher

GameUpdatesBatcher Photon.LoadBalancing.GameServer.GameApplication.GameUpdatesBatcher

get

◆ GamingSecureWebSocketPort

int? Photon.LoadBalancing.GameServer.GameApplication.GamingSecureWebSocketPort

getset

◆ GamingTcpPort

int? Photon.LoadBalancing.GameServer.GameApplication.GamingTcpPort

getprotected set

◆ GamingUdpPort

int? Photon.LoadBalancing.GameServer.GameApplication.GamingUdpPort

getprotected set

◆ GamingWebRTCPort

int? Photon.LoadBalancing.GameServer.GameApplication.GamingWebRTCPort

getprotected set

◆ GamingWebSocketPort

int? Photon.LoadBalancing.GameServer.GameApplication.GamingWebSocketPort

getprotected set

◆ GamingWsPath

string Photon.LoadBalancing.GameServer.GameApplication.GamingWsPath

getprotected set

◆ IsMaster

bool Photon.LoadBalancing.GameServer.GameApplication.IsMaster

getsetprotected

◆ MasterEndPoint

IPEndPoint Photon.LoadBalancing.GameServer.GameApplication.MasterEndPoint

getprotected set

◆ MasterServerConnection

MasterServerConnection Photon.LoadBalancing.GameServer.GameApplication.MasterServerConnection

getprotected set

◆ PublicIpAddress

IPAddress Photon.LoadBalancing.GameServer.GameApplication.PublicIpAddress

getprotected set

◆ PublicIpAddressIPv6

IPAddress Photon.LoadBalancing.GameServer.GameApplication.PublicIpAddressIPv6

getprotected set

◆ S2SCacheMan

S2SCustomTypeCacheMan Photon.LoadBalancing.GameServer.GameApplication.S2SCacheMan

getprotected set

◆ ServerId

Guid Photon.LoadBalancing.GameServer.GameApplication.ServerId

get

◆ ServerState

ServerState Photon.LoadBalancing.GameServer.GameApplication.ServerState

get

◆ TokenCreator

AuthTokenFactory Photon.LoadBalancing.GameServer.GameApplication.TokenCreator

getprotected set

◆ WorkloadController

WorkloadController Photon.LoadBalancing.GameServer.GameApplication.WorkloadController

getprotected set

Photon Server API Documentation v5.0RC1

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Constructor & Destructor Documentation

◆ GameApplication() [1/2]

◆ GameApplication() [2/2]

Member Function Documentation

◆ CheckGames()

◆ CreateGamePeer()

◆ CreatePeer()

◆ GetAuthTokenFactory()

◆ GetS2SCustomTypeCache()

◆ InitGameCache()

◆ Initialize()

◆ InitLogging()

◆ OnDisconnectFromMaster()

◆ OnMasterConnectionEstablished()

◆ OnMasterConnectionFailed()

◆ OnNewServerState()

◆ OnRegisteredAtMaster()

◆ OnStopRequested()

◆ RaiseOfflineEvent()

◆ Setup()

◆ SetupMasterConnection()

◆ TearDown()

Member Data Documentation

◆ executionFiber

Property Documentation

◆ AppStatsPublisher

◆ ConnectRetryIntervalSeconds

◆ GameCache

◆ GameUpdatesBatcher

◆ GamingSecureWebSocketPort

◆ GamingTcpPort

◆ GamingUdpPort

◆ GamingWebRTCPort

◆ GamingWebSocketPort

◆ GamingWsPath

◆ IsMaster

◆ MasterEndPoint

◆ MasterServerConnection

◆ PublicIpAddress

◆ PublicIpAddressIPv6

◆ S2SCacheMan

◆ ServerId

◆ ServerState

◆ TokenCreator

◆ WorkloadController