Photon Server API
Public Member Functions | Protected Member Functions | Properties | List of all members
Photon.SocketServer.ApplicationBase Class Referenceabstract

The base class for a Photon application. The main method to override is CreatePeer. See Setup for initialization recommendations. More...

Inheritance diagram for Photon.SocketServer.ApplicationBase:
Photon.CounterPublisher.Application Photon.Hive.HiveApplication Photon.LoadBalancing.GameServer.GameApplication Photon.LoadBalancing.MasterServer.MasterApplication Photon.MmoDemo.Server.PhotonApplication Photon.LoadBalancing.UnitTests.UnifiedServer.OfflineExtra.TestApplication

Public Member Functions

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)
 
IPhotonApplication OnStart (string instanceName, string applicationName, IPhotonApplicationSink sink, IControlListeners controlListners, 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

 ApplicationBase ()
 Initializes a new instance of the ApplicationBase class. More...
 
abstract 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 IFiber CreatePeerFiber (InitRequest request)
 
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 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...
 
abstract 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...
 
abstract void TearDown ()
 This method is called when the current application is being stopped. The inheritor can execute cleanup routines here. More...
 
new MarshalByRefObject MemberwiseClone (bool cloneIdentity)
 

Properties

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

Detailed Description

The base class for a Photon application. The main method to override is CreatePeer. See Setup for initialization recommendations.

Constructor & Destructor Documentation

Photon.SocketServer.ApplicationBase.ApplicationBase ( )
inlineprotected

Initializes a new instance of the ApplicationBase class.

Member Function Documentation

void Photon.SocketServer.ApplicationBase.BroadCastEvent< TPeer > ( IEventData  eventData,
IEnumerable< TPeer >  peers,
SendParameters  sendParameters 
)
inline

Sends an event to a list of peers. This method serializes the data just once per protocol instead of once per peer.

Template Parameters
TPeerA PeerBase subclass type.
Parameters
eventDataThe event to send.
peersThe peers to send the event to.
sendParametersThe send options.
Type Constraints
TPeer :PeerBase 
bool Photon.SocketServer.ApplicationBase.ConnectToServer ( IPEndPoint  remoteEndPoint,
string  applicationName,
object  state 
)
inline

This method overload is obsolete; use ConnectToServerTcp.

bool Photon.SocketServer.ApplicationBase.ConnectToServer ( IPEndPoint  remoteEndPoint,
bool  useMux,
string  applicationName,
object  state 
)
inline

This method overload is obsolete; use ConnectToServerMuxTcp.

bool Photon.SocketServer.ApplicationBase.ConnectToServer ( IPEndPoint  remoteEndPoint,
string  applicationName,
object  state,
IRpcProtocol  protocol 
)
inline

This method overload is obsolete; use ConnectToServerTcp.

bool Photon.SocketServer.ApplicationBase.ConnectToServer ( IPEndPoint  remoteEndPoint,
string  applicationName,
object  state,
byte  numChannels,
short?  mtu 
)
inline

This method overload is obsolete; use ConnectToServerUdp.

bool Photon.SocketServer.ApplicationBase.ConnectToServerMuxTcp ( IPEndPoint  remoteEndPoint,
string  applicationName,
object  state 
)
inline

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.

Parameters
remoteEndPointThe remote endpoint to connect to.
applicationNameThe application name to connect to.
stateA state object that is returned with the callback.
Returns
Returns true if outbound connections are allowed (if Running is true).
bool Photon.SocketServer.ApplicationBase.ConnectToServerTcp ( IPEndPoint  remoteEndPoint,
string  applicationName,
object  state 
)
inline

Establishes a TCP connection between two Photon instances. CreateServerPeer is called once the connection is established. OnServerConnectionFailed is called if the connection fails.

Parameters
remoteEndPointThe remote endpoint to connect to.
applicationNameThe application name to connect to.
stateA state object that is returned with the callback.
Returns
Returns true if outbound connections are allowed (if Running is true).
bool Photon.SocketServer.ApplicationBase.ConnectToServerTcp ( IPEndPoint  remoteEndPoint,
string  applicationName,
object  state,
IRpcProtocol  protocol 
)
inline

Establishes a TCP connection between two Photon instances. CreateServerPeer is called once the connection is established. OnServerConnectionFailed is called if the connection fails.

Parameters
remoteEndPointThe remote endpoint to connect to.
applicationNameThe application name to connect to.
stateA state object that is returned with the callback.
protocolThe IRpcProtocol used to serialze message data./>
Returns
Returns true if outbound connections are allowed (if Running is true).
bool Photon.SocketServer.ApplicationBase.ConnectToServerUdp ( IPEndPoint  remoteEndPoint,
string  applicationName,
object  state,
byte  numChannels,
short?  mtu 
)
inline

Establishes an UDP connection between two Photon instances. CreateServerPeer is called once the connection is established. OnServerConnectionFailed is called if the connection fails.

Parameters
remoteEndPointThe remote endpoint to connect to.
applicationNameThe application name to connect to.
stateA state object that is returned with the callback.
numChannelsThe number of channels used by the connection. Channels are prioritized (the lower the channel number, the higher the priority)
mtuMaximum transfer unit - specifies the max data size of each UDP package (in bytes). Bigger packages will be fragmented. The default value is 1200.
Returns
Returns true if outbound connections are allowed (if Running is true).
bool Photon.SocketServer.ApplicationBase.ConnectToServerWebSocket ( IPEndPoint  remoteEndPoint,
string  applicationName,
object  state,
WebSocketVersion  webSocketVersion,
IRpcProtocol  protocol 
)
inline

Establishes an WebSocket connection between two Photon instances. CreateServerPeer is called once the connection is established. OnServerConnectionFailed is called if the connection fails.

Parameters
remoteEndPointThe remote endpoint to connect to.
applicationNameThe application name to connect to.
stateA state object that is returned with the callback.
webSocketVersionThe websocket protocol version (currently supported: RF6455 and HyBi10)
protocolThe protocol to serialize the message data.
Returns
Returns true if outbound connections are allowed (if Running is true).
bool Photon.SocketServer.ApplicationBase.ConnectToServerWebSocketHixie76 ( IPEndPoint  remoteEndPoint,
string  applicationName,
object  state,
string  origin 
)
inline

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.

Parameters
remoteEndPointThe remote endpoint to connect to.
applicationNameThe application name to connect to.
stateA state object that is returned with the callback.
originThe origin of the request.
Returns
Returns true if outbound connections are allowed (if Running is true).
override System.Runtime.Remoting.ObjRef Photon.SocketServer.ApplicationBase.CreateObjRef ( Type  requestedType)
inline
abstract PeerBase Photon.SocketServer.ApplicationBase.CreatePeer ( InitRequest  initRequest)
protectedpure virtual

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.

Implemented in Photon.LoadBalancing.GameServer.GameApplication, Photon.LoadBalancing.MasterServer.MasterApplication, Photon.MmoDemo.Server.PhotonApplication, Photon.Hive.HiveApplication, and Photon.CounterPublisher.Application.

virtual IFiber Photon.SocketServer.ApplicationBase.CreatePeerFiber ( InitRequest  request)
inlineprotectedvirtual
new object Photon.SocketServer.ApplicationBase.GetLifetimeService ( )
inline
override object Photon.SocketServer.ApplicationBase.InitializeLifetimeService ( )
inline
string [] Photon.SocketServer.ApplicationBase.ListenerList ( out ListenerStatus[]  status)
inline
bool Photon.SocketServer.ApplicationBase.ListenerStart ( string  name)
inline
bool Photon.SocketServer.ApplicationBase.ListenerStop ( string  name)
inline
new MarshalByRefObject Photon.SocketServer.ApplicationBase.MemberwiseClone ( bool  cloneIdentity)
inlineprotected
virtual void Photon.SocketServer.ApplicationBase.OnServerConnectionFailed ( int  errorCode,
string  errorMessage,
object  state 
)
inlineprotectedvirtual

Invoked if a connection attempt to a server fails.

Parameters
errorCodeThe error code.
errorMessageThe error message.
stateThe state.

Reimplemented in Photon.LoadBalancing.GameServer.GameApplication.

IPhotonApplication Photon.SocketServer.ApplicationBase.OnStart ( string  instanceName,
string  applicationName,
IPhotonApplicationSink  sink,
IControlListeners  controlListners,
IPhotonApplicationsCounter  applicationsCounter,
string  unmanagedLogDirectory 
)
inline

Called when the application is started. This method calls Setup.

Parameters
instanceNameThe name of the instance.
applicationNameName of the application.
sinkThe sink.
controlListnersThe photon listener controler
applicationsCounterAn IPhotonApplicationsCounter instance used to read photon socket server unmanged counters.
unmanagedLogDirectoryThe log path of Photon.
Returns
PhotonApplication object.
virtual void Photon.SocketServer.ApplicationBase.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 in Photon.LoadBalancing.GameServer.GameApplication, and Photon.LoadBalancing.MasterServer.MasterApplication.

abstract void Photon.SocketServer.ApplicationBase.Setup ( )
protectedpure virtual

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
}

Implemented in Photon.LoadBalancing.GameServer.GameApplication, Photon.LoadBalancing.MasterServer.MasterApplication, Photon.Hive.HiveApplication, Photon.MmoDemo.Server.PhotonApplication, Photon.CounterPublisher.Application, and Photon.LoadBalancing.UnitTests.UnifiedServer.OfflineExtra.TestApplication.

abstract void Photon.SocketServer.ApplicationBase.TearDown ( )
protectedpure virtual

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

Implemented in Photon.LoadBalancing.GameServer.GameApplication, Photon.LoadBalancing.MasterServer.MasterApplication, Photon.Hive.HiveApplication, Photon.MmoDemo.Server.PhotonApplication, and Photon.CounterPublisher.Application.

Property Documentation

string Photon.SocketServer.ApplicationBase.ApplicationName
get

Gets the application name set in PhotonServer.config.

string Photon.SocketServer.ApplicationBase.ApplicationPath
get

Gets the application path set in PhotonServer.config.

string Photon.SocketServer.ApplicationBase.ApplicationRootPath
get

Gets the path of the application root path - base location of all applications.

string Photon.SocketServer.ApplicationBase.BinaryPath
get

Gets the path of the application binaries.

Version Photon.SocketServer.ApplicationBase.CoreVersion
get

Gets Photon Native Core version (PhotonSocketServer.exe).

string Photon.SocketServer.ApplicationBase.HwId
get
ApplicationBase Photon.SocketServer.ApplicationBase.Instance
staticget

Gets the application instance.

int Photon.SocketServer.ApplicationBase.PeerCount
get

Gets the number of peers currently connected to the application.

The peer count.

string Photon.SocketServer.ApplicationBase.PhotonInstanceName
get

Gets the name of the photon instance.

bool Photon.SocketServer.ApplicationBase.Running
get

Gets a value indicating whether the application is running (the time between Setup and OnStopRequested).

Version Photon.SocketServer.ApplicationBase.SdkVersion
get

Gets Photon Managed Core version (SDK).

string Photon.SocketServer.ApplicationBase.UnmanagedLogPath
get

Gets the log path of Photon.