File: ServerInfo.h

package info (click to toggle)
eris 1.2.1-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 2,360 kB
  • ctags: 1,348
  • sloc: sh: 8,289; cpp: 7,576; perl: 287; ansic: 172; makefile: 143
file content (89 lines) | stat: -rw-r--r-- 2,915 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
#ifndef ERIS_SERVER_INFO_H
#define ERIS_SERVER_INFO_H

#include <string>

namespace Atlas {
  namespace Objects {
    namespace Entity { class RootEntity; }
  }
}

namespace Eris {
	
class Meta;

/** Information about a specific game server, retrieved via the Meta-server and anonymous GETs. The
information includes statistics (uptime, number of clients), configuration (ruleset) and general
information (an adminsitrator specifed name). This data is intended to allow clients to display a browser
interface, similar to those found in Quake 3 or Tribes 2, from which they can select a server to play on. Note
that in the future, each ServerInfo will represent a game world instance, not necessarily a single server,
and that a single server might run multiple games. Thus, hostname / IP is a very poor ordering / caching
value.
\task Some sort of unique game-instance ID may need to be developed here.
*/
class ServerInfo
{
public:
	// bookmark / favourites functionality 	

	// accessors
	/** retrive the hostname (or dotted-decimal IP) of the server. For multi-server worlds, this will be
	a name that resolves to a machine capable of accepting the initial LOGIN, and hence should not need
	special handling. */
	const std::string& getHostname() const
	{ return _host; }

	/// retrieve the human-readable name of the server (e.g 'Bob's Mason Server')
	const std::string& getServername() const
	{ return _host; }
	
	/// retrieve a human-readable name of the ruleset (e.g. 'mason' or 'circe')
	const std::string& getRuleset() const
	{ return _ruleset; }
	
	/// the server program name, i.e 'stage' or 'cyphesis'
	const std::string& getServer() const
	{ return _server; }
	
	/// the number of clients currently connected to the server
	int getNumClients() const
	{ return _clients; }

	/** the round-trip time to the server. The meaning of this when multi-server worlds exist needs to
	be considered.
	\task Verify the accuracy of the ping estimation, since it is currently very poor */
	int getPing() const
	{ return _ping; }

	/// the server's uptime in seconds
	double getUptime() const
	{ return _uptime; }
	
protected:
	friend class Meta;

	/// construct with the host IP only; other values will be set to defaults
	ServerInfo(const std::string &host);
	
	/// called by Meta when info is recieved from the server
	void processServer(const Atlas::Objects::Entity::RootEntity &svr);

	void setPing(int p);
	
	std::string _host;		///< Hostname or dotted-decimal IP of the server

	std::string _name,		///< Human readable name of the server (set by the operator)
		_ruleset,	///< The game system this server is running (e.g. 'Acorn')
		_server;	///< Server program (e.g. 'Cyphesis' or 'Stage')	
	
	int _clients;		///< Number of clients connected to the server
	int _ping;			///< Estimated round-trip-time (ping) in milliseconds
	
	double _uptime;		///< Server uptime in seconds
};

} // of namespace Eris

#endif