Net_GameServerQuery
[ class tree: Net_GameServerQuery ] [ index: Net_GameServerQuery ] [ all elements ]

Class: Net_GameServerQuery

Source Location: /Net_GameServerQuery-0.3.0/Net/GameServerQuery.php

Class Overview


Query and retrieve information from game servers


Author(s):

Methods


Inherited Variables

Inherited Methods


Class Details

[line 45]
Query and retrieve information from game servers


[ Top ]


Method Detail

__construct (Constructor)   [line 105]

Net_GameServerQuery __construct( )

Constructor

Load the classes needed throughout the script

  • Access: public

[ Top ]

addServer   [line 162]

int addServer( string $game, string $addr, [int $port = null], [string $query = '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   $query     A pipe delimited string of query types

[ Top ]

execute   [line 202]

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 146]

void getOption( string $option)

Get an option

Wraps around the method in Net_GameServerQuery_Config

  • Access: public

Parameters:

string   $option     The option to get

[ Top ]

setOption   [line 131]

void setOption( string $option, string $value)

Set an option

Wraps around the method in Net_GameServerQuery_Config

  • Access: public

Parameters:

string   $option     The option to set
string   $value     The value

[ Top ]


Documentation generated on Wed, 06 Oct 2010 01:00:06 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.