Docs For Class Net_GameServerQuery

Class: Net_GameServerQuery

Inherited Variables

Inherited Methods

Class Details

[line 36]
Query and retrieve information from game servers

Author: Tom Buskens <ortega@php.net>
Author: Aidan Lister <aidan@php.net>
Version: $Revision: 1.45 $

Method Detail

__construct (Constructor) [line 96]

Net_GameServerQuery __construct(
)

Constructor

Load the classes needed throughout the script

Access: public

[ Top ]

addServer [line 160]

int addServer(
string
$game, string
$addr, [int
$port = null], [
$query = 'status'], string
$status)

Add a server

Return: The number used to identify the server just added
Access: public

Parameters:

string	`$game`	—	The type of game
string	`$addr`	—	The address to query
int	`$port`	—	The port to query
string	`$status`	—	A pipe delimited string of query types
	`$query`	—

[ Top ]

execute [line 199]

array execute(
[int
$timeout = null])

Execute the query

Communicate with the server, then send the information for processing. Then, reconstruct the array so the user can access the data.

Return: An array of server information
Access: public

Parameters:

int $timeout — The timeout in milliseconds

[ Top ]

getOption [line 135]

void getOption(
string
$option)

Get an option

Access: public

Parameters:

string $option — The option to get

[ Top ]

setOption [line 114]

void setOption(
string
$option, string
$value)

Set an option

Access: public

Parameters:

string	`$option`	—	The option to set
string	`$value`	—	The value

[ Top ]

Class: Net_GameServerQuery

Class Overview

Author(s):

Version:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

__construct (Constructor) [line 96]

addServer [line 160]

Parameters:

execute [line 199]

Parameters:

getOption [line 135]

Parameters:

setOption [line 114]

Parameters: