Photon Server API

Public Member Functions | Protected Member Functions | Properties | List of all members
Photon.LoadBalancing.MasterServer.MasterApplication Class Reference
Inheritance diagram for Photon.LoadBalancing.MasterServer.MasterApplication:
Photon.SocketServer.ApplicationBase

Public Member Functions

 MasterApplication ()
 
IPAddress GetInternalMasterNodeIpAddress ()
 
virtual void RemoveGameServerFromLobby (IncomingGameServerPeer gameServerPeer)
 
CustomTypeCache GetS2SCustomTypeCache ()
 
- 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)
 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 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)
 This method overload is obsolete; use ConnectToServerUdp. More...
 
string[] ListenerList (out ListenerStatus[] status)
 
bool ListenerStart (string name)
 
bool ListenerStop (string name)
 
void OnWebRTCConnectionEstablished (IPhotonWebRTCPeer peer, byte maxChannelCount, uint flags)
 
void OnOutboundWebRTCConnectionEstablished (IPhotonWebRTCPeer peer, object userData, byte maxChannelCount, uint flags)
 
void OnOutboundWebRTCConnectionFailed (object userData, uint errorCode)
 
void OnWebRTCChannelConnected (IPhotonWebRTCPeer peer, object userData, byte channelId, ChannelType ChannelType, bool unordered, ushort priority, uint reliability, string label, string protocol)
 
void OnWebRTCChannelDestroyed (IPhotonWebRTCPeer peer, object userData, byte channelId)
 
IPhotonApplication OnStart (string instanceName, string applicationName, IPhotonApplicationSink sink, IControlListeners controlListners, PhotonHostRuntimeInterfaces.ILogToUnmanagedLog unmanagedLog, IPhotonApplicationsCounter applicationsCounter, string unmanagedLogDirectory)
 Called when the application is started. This method calls Setup. More...
 
override System.Runtime.Remoting.ObjRef CreateObjRef (Type requestedType)
 
new object GetLifetimeService ()
 
override object InitializeLifetimeService ()
 

Protected Member Functions

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 Initialize ()
 
virtual bool IsGameServerPeer (InitRequest initRequest)
 
override void OnStopRequested ()
 Called when photon starts a new app domain for the same application. New connections will connect to the new app domain. This app domain continues to receive operations until from existing connections until the last peer disconnects. 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 InitLogging ()
 
override void TearDown ()
 This method is called when the current application is being stopped. The inheritor can execute cleanup routines here. More...
 
- Protected Member Functions inherited from Photon.SocketServer.ApplicationBase
 ApplicationBase ()
 Initializes a new instance of the ApplicationBase class. More...
 
virtual IFiber CreatePeerFiber (InitRequest request)
 
virtual void OnServerConnectionFailed (int errorCode, string errorMessage, object state)
 Invoked if a connection attempt to a server fails. More...
 
new MarshalByRefObject MemberwiseClone (bool cloneIdentity)
 

Properties

static ApplicationStats AppStats [get, protected set]
 
GameServerCollection GameServers [get, protected set]
 
bool IsMaster [get]
 
LoadBalancer< IncomingGameServerPeerLoadBalancer [get, protected set]
 
byte LocalNodeId [get]
 
byte MasterNodeId [get, set]
 
GameApplication DefaultApplication [get]
 
AuthTokenFactory TokenCreator [get, protected set]
 
CustomAuthHandler CustomAuthHandler [get, protected set]
 
S2SCustomTypeCacheMan S2SCustomTypeCacheMan [get, protected set]
 
- Properties inherited from Photon.SocketServer.ApplicationBase
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...
 

Constructor & Destructor Documentation

◆ MasterApplication()

Photon.LoadBalancing.MasterServer.MasterApplication.MasterApplication ( )
inline

Member Function Documentation

◆ CreatePeer()

override PeerBase Photon.LoadBalancing.MasterServer.MasterApplication.CreatePeer ( InitRequest  initRequest)
inlineprotectedvirtual

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

Parameters
initRequestThe initialization request.
Returns
A new instance of PeerBase or null.

Implements Photon.SocketServer.ApplicationBase.

◆ GetInternalMasterNodeIpAddress()

IPAddress Photon.LoadBalancing.MasterServer.MasterApplication.GetInternalMasterNodeIpAddress ( )
inline

◆ GetS2SCustomTypeCache()

CustomTypeCache Photon.LoadBalancing.MasterServer.MasterApplication.GetS2SCustomTypeCache ( )
inline

◆ Initialize()

virtual void Photon.LoadBalancing.MasterServer.MasterApplication.Initialize ( )
inlineprotectedvirtual

◆ InitLogging()

virtual void Photon.LoadBalancing.MasterServer.MasterApplication.InitLogging ( )
inlineprotectedvirtual

◆ IsGameServerPeer()

virtual bool Photon.LoadBalancing.MasterServer.MasterApplication.IsGameServerPeer ( InitRequest  initRequest)
inlineprotectedvirtual

◆ OnStopRequested()

override void Photon.LoadBalancing.MasterServer.MasterApplication.OnStopRequested ( )
inlineprotectedvirtual

Called when photon starts a new app domain for the same application. New connections will connect to the new app domain. This app domain continues to receive operations until from existing connections until the last peer disconnects.

This feature requires the AutoRestart setting in the PhotonServer.config. Please refer to the configuration manual for more details.

Reimplemented from Photon.SocketServer.ApplicationBase.

◆ RemoveGameServerFromLobby()

virtual void Photon.LoadBalancing.MasterServer.MasterApplication.RemoveGameServerFromLobby ( IncomingGameServerPeer  gameServerPeer)
inlinevirtual

◆ Setup()

override void Photon.LoadBalancing.MasterServer.MasterApplication.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
}

Implements Photon.SocketServer.ApplicationBase.

◆ TearDown()

override void Photon.LoadBalancing.MasterServer.MasterApplication.TearDown ( )
inlineprotectedvirtual

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

Implements Photon.SocketServer.ApplicationBase.

Property Documentation

◆ AppStats

ApplicationStats Photon.LoadBalancing.MasterServer.MasterApplication.AppStats
staticgetprotected set

◆ CustomAuthHandler

CustomAuthHandler Photon.LoadBalancing.MasterServer.MasterApplication.CustomAuthHandler
getprotected set

◆ DefaultApplication

GameApplication Photon.LoadBalancing.MasterServer.MasterApplication.DefaultApplication
get

◆ GameServers

GameServerCollection Photon.LoadBalancing.MasterServer.MasterApplication.GameServers
getprotected set

◆ IsMaster

bool Photon.LoadBalancing.MasterServer.MasterApplication.IsMaster
get

◆ LoadBalancer

LoadBalancer<IncomingGameServerPeer> Photon.LoadBalancing.MasterServer.MasterApplication.LoadBalancer
getprotected set

◆ LocalNodeId

byte Photon.LoadBalancing.MasterServer.MasterApplication.LocalNodeId
getprotected

◆ MasterNodeId

byte Photon.LoadBalancing.MasterServer.MasterApplication.MasterNodeId
getsetprotected

◆ S2SCustomTypeCacheMan

S2SCustomTypeCacheMan Photon.LoadBalancing.MasterServer.MasterApplication.S2SCustomTypeCacheMan
getprotected set

◆ TokenCreator

AuthTokenFactory Photon.LoadBalancing.MasterServer.MasterApplication.TokenCreator
getprotected set
ExitGames.Logging
Definition: ILogger.cs:10
Photon.LoadBalancing.MasterServer.MasterApplication.Setup
override void Setup()
This method is called when the current application has been started. The inheritor can setup log4net ...
Definition: MasterApplication.cs:244
ExitGames.Logging.LogManager.SetLoggerFactory
static void SetLoggerFactory(ILoggerFactory factory)
Assigns a new ILoggerFactory to create ILogger instances.
Definition: LogManager.cs:86
ExitGames.Logging.Log4Net
Definition: Log4NetLogger.cs:10
ExitGames.Logging.LogManager
The log manager provides methods to get instances of ILogger using a ILoggerFactory....
Definition: LogManager.cs:23
Photon.LoadBalancing.MasterServer.LogManager
ExitGames.Logging.LogManager LogManager
Definition: MasterApplication.cs:37
ExitGames.Logging.Log4Net.Log4NetLoggerFactory.Instance
static readonly Log4NetLoggerFactory Instance
The singleton.
Definition: Log4NetLoggerFactory.cs:24
ExitGames.Logging.LogManager.GetCurrentClassLogger
static ILogger GetCurrentClassLogger()
Gets an ILogger for the calling class type.
Definition: LogManager.cs:60
ExitGames
Definition: CachedFunc.cs:10
ExitGames.Logging.Log4Net.Log4NetLoggerFactory
This ILoggerFactory creates ILogger that log to the log4net framework.
Definition: Log4NetLoggerFactory.cs:19