Main Page | Modules | Data Structures | File List | Data Fields | Globals

Querying Master Servers


Data Structures

struct  GS_SERVER
 A linked list of servers returned from GSQueryMaster(). More...

Enumerations

enum  GS_MASTER {
  GS_MASTER_DOOM3 = 0, GS_MASTER_QUAKE3, GS_MASTER_QUAKE2, GS_MASTER_RTCW,
  GS_MASTER_WOLFET, GS_MASTER_SWJK2, GS_MASTER_HALFLIFE, GS_MASTER_CS,
  GS_MASTER_CSCZ, GS_MASTER_CSS, GS_MASTER_DOD, GS_MASTER_SOF2,
  GS_MASTER_SWJKJA, GS_MASTER_STVEF, GS_MASTER_STVEF2
}
 Master server types. More...
enum  GS_MASTER_FILTER {
  GS_MASTER_FILTER_NONE = 0, GS_MASTER_FILTER_FULL = 1, GS_MASTER_FILTER_NOTFULL = 2, GS_MASTER_FILTER_EMPTY = 4,
  GS_MASTER_FILTER_NOTEMPTY = 8, GS_MASTER_FILTER_PASSWORD = 16, GS_MASTER_FILTER_NOPASSWORD = 32
}
 Master server filters. More...

Functions

GS_SERVERGSQueryMaster (unsigned short type, const char *host, unsigned short port, unsigned short filter)
 Queries a master server for game servers.
void GSFreeServers (GS_SERVER *servers)
 Frees the server list returned by GSQueryMaster().

Enumeration Type Documentation

enum GS_MASTER
 

Master server types.

Enumeration values:
GS_MASTER_DOOM3  Doom 3.
GS_MASTER_QUAKE3  Quake 3.
GS_MASTER_QUAKE2  Quake 2.
GS_MASTER_RTCW  Return to Castle Wolfenstein.
GS_MASTER_WOLFET  Wolfenstein: Enemy Territory.
GS_MASTER_SWJK2  Star Wars Jedi Knight 2: Jedi Outcast.
GS_MASTER_HALFLIFE  Half-Life.
GS_MASTER_CS  Counter-Strike.
GS_MASTER_CSCZ  Counter-Strike: Condition Zero.
GS_MASTER_CSS  Counter-Strike: Source.
GS_MASTER_DOD  Day of Defeat.
GS_MASTER_SOF2  Soldier of Fortune 2.
GS_MASTER_SWJKJA  Star Wars Jedi Knight: Jedi Academy.
GS_MASTER_STVEF  Star Trek: Voyager - Elite Force.
GS_MASTER_STVEF2  Star Trek: Voyager - Elite Force 2.

enum GS_MASTER_FILTER
 

Master server filters.

Enumeration values:
GS_MASTER_FILTER_NONE  All servers.
GS_MASTER_FILTER_FULL  Full servers.
GS_MASTER_FILTER_NOTFULL  Servers that aren't full.
GS_MASTER_FILTER_EMPTY  Empty servers.
GS_MASTER_FILTER_NOTEMPTY  Servers that aren't empty.
GS_MASTER_FILTER_PASSWORD  Servers that require a password.
GS_MASTER_FILTER_NOPASSWORD  Servers that don't require a password.


Function Documentation

void GSFreeServers GS_SERVER servers  ) 
 

Frees the server list returned by GSQueryMaster().

Parameters:
servers The server list to free.
Since:
1.1

GS_SERVER* GSQueryMaster unsigned short  type,
const char *  host,
unsigned short  port,
unsigned short  filter
 

Queries a master server for game servers.

Parameters:
type Describes the type of server to query. Must be one of the GS_MASTER_* enumerations.
host A string containing a valid hostname, IPv4, or IPv6 address. If this is NULL, GameStat will try to guess it for you.
port The port to contact the server on. If this is 0 GameStat will try to guess it for you.
filter Describes the type of servers to retrieve. Can be a combination of the GS_MASTER_FILTER* enumerations.
Returns:
On success, a linked list of servers. On failure, NULL. To find out why, call GSLastError().
See also:
GS_MASTER, GS_MASTER_FILTER, GSFreeServers()
Since:
1.1


Generated on Wed Oct 6 01:04:06 2004 for GameStat by  doxygen 1.3.9