Photon Server API
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.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 inital server state of the game server instance. More...
 
int HttpPort [get, set]
 Gets or sets the port of the game server instance used for rHTTP connections. More...
 
int SecureWebSocketPort [get, set]
 Gets or sets the port of the game server instance used for secure WebSocket connections. More...
 
string HttpPath [get, set]
 Gets or sets the path of the game server application instance used for rHTTP connections. More...
 
int SecureHttpPort [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...
 
- Properties inherited from Photon.SocketServer.Rpc.Operation
OperationRequest OperationRequest [get]
 Gets the 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...
 

Additional Inherited Members

- 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

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.
Photon.LoadBalancing.ServerToServer.Operations.RegisterGameServer.RegisterGameServer ( )
inline

Initializes a new instance of the RegisterGameServer class.

Property Documentation

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

Gets or sets the public game server ip address.

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

Gets or sets the public game server ip address.

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

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

Gets or sets the path of the game server application instance used for rHTTP connections.

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

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

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

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

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

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

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

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

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

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

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

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

The TCP port.

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

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

The UDP port.

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

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