Inheritance diagram for Photon.NameServer.PhotonApp:

Public Member Functions
	PhotonApp ()

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
	PhotonApp (IConfiguration configuration)

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

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	SetupLog4net ()

virtual void	Initialize ()

virtual bool	ReadNameServerConfigurationFile (out string message)

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

virtual AuthTokenFactory	GetAuthTokenFactory ()

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

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

Static Protected Member Functions
static string	GetNameServerConfig ()

Properties
AuthTokenFactory	TokenCreator `[get]`

CustomAuthHandler	CustomAuthHandler `[get]`

MasterServerCache	ServerCache `[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

◆ PhotonApp() [1/2]

Photon.NameServer.PhotonApp.PhotonApp ( )

inline

◆ PhotonApp() [2/2]

Photon.NameServer.PhotonApp.PhotonApp ( IConfiguration configuration )

inlineprotected

Member Function Documentation

◆ CreatePeer()

override PeerBase Photon.NameServer.PhotonApp.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.NameServer.PhotonApp.GetAuthTokenFactory ( )

inlineprotectedvirtual

◆ GetNameServerConfig()

static string Photon.NameServer.PhotonApp.GetNameServerConfig ( )

inlinestaticprotected

◆ Initialize()

virtual void Photon.NameServer.PhotonApp.Initialize ( )

inlineprotectedvirtual

◆ ReadNameServerConfigurationFile()

virtual bool Photon.NameServer.PhotonApp.ReadNameServerConfigurationFile ( out string message )

inlineprotectedvirtual

◆ Setup()

override void Photon.NameServer.PhotonApp.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.

◆ SetupLog4net()

virtual void Photon.NameServer.PhotonApp.SetupLog4net ( )

inlineprotectedvirtual

◆ TearDown()

override void Photon.NameServer.PhotonApp.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

◆ CustomAuthHandler

CustomAuthHandler Photon.NameServer.PhotonApp.CustomAuthHandler

get

◆ ServerCache

MasterServerCache Photon.NameServer.PhotonApp.ServerCache

get

◆ TokenCreator

AuthTokenFactory Photon.NameServer.PhotonApp.TokenCreator

get

Photon Server API Documentation v5.0RC1

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Properties

Additional Inherited Members

Constructor & Destructor Documentation

◆ PhotonApp() [1/2]

◆ PhotonApp() [2/2]

Member Function Documentation

◆ CreatePeer()

◆ GetAuthTokenFactory()

◆ GetNameServerConfig()

◆ Initialize()

◆ ReadNameServerConfigurationFile()

◆ Setup()

◆ SetupLog4net()

◆ TearDown()

Property Documentation

◆ CustomAuthHandler

◆ ServerCache

◆ TokenCreator