C# Class ACR_ServerCommunicator.GameServer

This object maintains state about a game server, gathered from the database.
Inheritance: IGameEntity
Show file Open project: ALandFarAway/ALFA-Base-Resources Class Usage Examples

Public Methods

Method Description
GameServer ( GameWorldManager WorldManager ) : System

Construct a new GameServer object.
GetIPAddress ( ) : IPAddress

Get the IP address of the server. Raises an exception on failure.
PopulateFromDatabase ( IALFADatabase Database ) : void

Retrieve the properties of the server from the database.
RefreshOnlineStatus ( IALFADatabase Database ) : void

Re-compute the online status for the server.
SetHostnameAndPort ( string AddressString ) : void

Set the hostname and port based on parsing an address string, which may be either 'hostname' or 'hostname:port'. The default port of 5121 is used if no port was set.

Method Details

GameServer() public method

Construct a new GameServer object.
public GameServer ( GameWorldManager WorldManager ) : System
WorldManager GameWorldManager Supplies the game world manager. ///
return System

GetIPAddress() public method

Get the IP address of the server. Raises an exception on failure.
public GetIPAddress ( ) : IPAddress
return System.Net.IPAddress

PopulateFromDatabase() public method

Retrieve the properties of the server from the database.
public PopulateFromDatabase ( IALFADatabase Database ) : void
Database IALFADatabase Supplies the database connection to use for /// queries, if required. The active rowset may be consumed.
return void

RefreshOnlineStatus() public method

Re-compute the online status for the server.
public RefreshOnlineStatus ( IALFADatabase Database ) : void
Database IALFADatabase Supplies the database connection to use for /// queries, if required. The active rowset may be consumed.
return void

SetHostnameAndPort() public method

Set the hostname and port based on parsing an address string, which may be either 'hostname' or 'hostname:port'. The default port of 5121 is used if no port was set.
public SetHostnameAndPort ( string AddressString ) : void
AddressString string Supplies the address string to set the /// server network address information from.
return void