Photon Server API Documentation v5.0RC1

Public Member Functions | Properties | List of all members
Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer Class Reference

Defines the parameters which should be send from game server instances to register at the master application. More...

Inheritance diagram for Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer:
Photon.SocketServer.Rpc.Operation Photon.LoadBalancing.ServerToServer.Operations.IRegisterGameServer Photon.SocketServer.Rpc.DataContract

Public Member Functions

 RegisterGameServer (IRpcProtocol rpcProtocol, OperationRequest operationRequest)
 Initializes a new instance of the RegisterGameServer class. More...
 
 RegisterGameServer ()
 Initializes a new instance of the RegisterGameServer class. More...
 
- Public Member Functions inherited from Photon.SocketServer.Rpc.Operation
 Operation (IRpcProtocol protocol, OperationRequest request)
 Initializes a new instance of the Operation class. This contructor is used for incoming operations. More...
 
 Operation ()
 Initializes a new instance of the Operation class. This contructor is used for outgoing operations. More...
 
void OnComplete ()
 Updates photon counters for the measure execution time. Call OnStart first. More...
 
void OnStart ()
 Starts measuring the execution time. Call OnComplete to update photon counters. More...
 
- Public Member Functions inherited from Photon.SocketServer.Rpc.DataContract
string GetErrorMessage ()
 Gets a message containing descriptive entries for each missing or invalid paramter. More...
 
Dictionary< byte, object > ToDictionary ()
 Converts all properties flagged with the DataMemberAttribute to a dictionary. More...
 

Properties

string GameServerAddress [get, set]
 Gets or sets the public game server ip address. More...
 
string ServerId [get, set]
 Gets or sets a unique server id. This id is used to sync reconnects. More...
 
int? TcpPort [get, set]
 Gets or sets the TCP port of the game server instance. More...
 
int? UdpPort [get, set]
 Gets or sets the UDP port of the game server instance. More...
 
int? WebSocketPort [get, set]
 Gets or sets the port of the game server instance used for WebSocket connections. More...
 
int ServerState [get, set]
 Gets or sets the initial server state of the game server instance. More...
 
int? SecureWebSocketPort [get, set]
 Gets or sets the port of the game server instance used for secure WebSocket connections. More...
 
string GameServerAddressIPv6 [get, set]
 Gets or sets the public game server ip address. More...
 
string GameServerHostName [get, set]
 Gets or sets the fully qualified public host name of the game server instance (used for WebSocket connections). More...
 
Dictionary< byte, int[]> PredictionData [get, set]
 Gets prediction data which were collected on GS More...
 
byte LoadLevelCount [get, set]
 Gets how many load levels used by GS More...
 
byte LoadBalancerPriority [get, set]
 Defines priority server belongs to More...
 
int? WebRTCPort [get, set]
 
byte LoadIndex [get, set]
 
byte[] SupportedProtocols [get, set]
 
string GamingWsPath [get, set]
 
- Properties inherited from Photon.SocketServer.Rpc.Operation
OperationRequest OperationRequest [get]
 Gets the underlying OperationRequest. More...
 
- Properties inherited from Photon.SocketServer.Rpc.DataContract
bool IsValid [get]
 Gets a value indicating whether all operation parameter are initialized. Call the GetErrorMessage method to get a detailed description for all missing parameters. More...
 
- Properties inherited from Photon.LoadBalancing.ServerToServer.Operations.IRegisterGameServer
string GameServerAddress [get, set]
 Gets or sets the public game server ip address. More...
 
string ServerId [get, set]
 Gets or sets a unique server id. This id is used to sync reconnects. More...
 
int? TcpPort [get, set]
 Gets or sets the TCP port of the game server instance. More...
 
int? UdpPort [get, set]
 Gets or sets the UDP port of the game server instance. More...
 
int? WebSocketPort [get, set]
 Gets or sets the port of the game server instance used for WebSocket connections. More...
 
int ServerState [get, set]
 Gets or sets the initial server state of the game server instance. More...
 
int? SecureWebSocketPort [get, set]
 Gets or sets the port of the game server instance used for secure WebSocket connections. More...
 
string GamingWsPath [get, set]
 Gets or sets the path of the game server application instance used for ws/wss connections. More...
 
int? WebRTCPort [get, set]
 
string GameServerAddressIPv6 [get, set]
 Gets or sets the public game server ip address. More...
 
string GameServerHostName [get, set]
 Gets or sets the fully qualified public host name of the game server instance (used for WebSocket connections). More...
 
Dictionary< byte, int[]> PredictionData [get, set]
 Gets prediction data which were collected on GS More...
 
byte LoadLevelCount [get, set]
 Gets how many load levels used by GS More...
 
byte LoadBalancerPriority [get, set]
 Defines priority server belongs to More...
 
byte LoadIndex [get, set]
 current load level More...
 
byte[] SupportedProtocols [get, set]
 List of protocols supported by Game Server More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Photon.SocketServer.Rpc.Operation
static long GetTimestamp ()
 
- Public Attributes inherited from Photon.SocketServer.Rpc.Operation
byte Code => this.OperationRequest.OperationCode
 
RequestMetaData RequestMetaData => this.OperationRequest?.RequestMetaData
 
- Protected Member Functions inherited from Photon.SocketServer.Rpc.Operation
virtual void OnCompleted ()
 this method is called from inside of OnComplete() if startTime is not null More...
 
virtual void OnStarted ()
 called from inside of OnStart just after startTime is set More...
 
- Protected Member Functions inherited from Photon.SocketServer.Rpc.DataContract
 DataContract (IRpcProtocol protocol, IDictionary< byte, object > dataMembers)
 Initializes a new instance of the DataContract class. The params dictionary is mapped to properties flagged with the DataMemberAttribute. Check the IsValid property after creation to determine if all paramters have been initialized correctly. More...
 
 DataContract ()
 Initializes a new instance of the DataContract class. More...
 
- Protected Attributes inherited from Photon.SocketServer.Rpc.DataContract
string errorMessage
 The error message. More...
 
bool isValid
 The is valid. More...
 

Detailed Description

Defines the parameters which should be send from game server instances to register at the master application.

Constructor & Destructor Documentation

◆ RegisterGameServer() [1/2]

Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.RegisterGameServer ( IRpcProtocol  rpcProtocol,
OperationRequest  operationRequest 
)
inline

Initializes a new instance of the RegisterGameServer class.

Parameters
rpcProtocolThe rpc Protocol.
operationRequestThe operation request.

◆ RegisterGameServer() [2/2]

Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.RegisterGameServer ( )
inline

Initializes a new instance of the RegisterGameServer class.

Property Documentation

◆ GameServerAddress

string Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.GameServerAddress
getset

Gets or sets the public game server ip address.

◆ GameServerAddressIPv6

string Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.GameServerAddressIPv6
getset

Gets or sets the public game server ip address.

◆ GameServerHostName

string Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.GameServerHostName
getset

Gets or sets the fully qualified public host name of the game server instance (used for WebSocket connections).

◆ GamingWsPath

string Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.GamingWsPath
getset

◆ LoadBalancerPriority

byte Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.LoadBalancerPriority
getset

Defines priority server belongs to

◆ LoadIndex

byte Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.LoadIndex
getset

◆ LoadLevelCount

byte Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.LoadLevelCount
getset

Gets how many load levels used by GS

◆ PredictionData

Dictionary<byte, int[]> Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.PredictionData
getset

Gets prediction data which were collected on GS

◆ SecureWebSocketPort

int? Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.SecureWebSocketPort
getset

Gets or sets the port of the game server instance used for secure WebSocket connections.

◆ ServerId

string Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.ServerId
getset

Gets or sets a unique server id. This id is used to sync reconnects.

◆ ServerState

int Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.ServerState
getset

Gets or sets the initial server state of the game server instance.

◆ SupportedProtocols

byte [] Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.SupportedProtocols
getset

◆ TcpPort

int? Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.TcpPort
getset

Gets or sets the TCP port of the game server instance.

The TCP port.

◆ UdpPort

int? Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.UdpPort
getset

Gets or sets the UDP port of the game server instance.

The UDP port.

◆ WebRTCPort

int? Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.WebRTCPort
getset

◆ WebSocketPort

int? Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.WebSocketPort
getset

Gets or sets the port of the game server instance used for WebSocket connections.