Class GameQ\Protocol

`abstract`

Handles the core functionality for the protocols

GameQ\Protocol

Located at GameQ/Protocol.php

Methods
`public`	`__construct(array $options = [])`	#
`public`	`__toString(): string` String name of this class String name of this class	#
`public`	`portDiff(): int` Get the port difference between the server's client (game) and query ports Get the port difference between the server's client (game) and query ports	#
`public`	`findQueryPort(int $clientPort): int` "Find" the query port based off of the client port and port_diff "Find" the query port based off of the client port and port_diff This method is meant to be overloaded for more complex maths or lookup tables Overriden by `GameQ\Protocols\Mohaa::findQueryPort()` `GameQ\Protocols\Dayz::findQueryPort()` `GameQ\Protocols\Risingstorm2::findQueryPort()`	#
`public`	`joinLink(): string` Return the join_link as defined by the protocol class Return the join_link as defined by the protocol class	#
`public`	`name(): string` Short (callable) name of this class Short (callable) name of this class	#
`public`	`nameLong(): string` Long name of this class Long name of this class	#
`public`	`state(): int` Return the status of this Protocol Class Return the status of this Protocol Class	#
`public`	`getProtocol(): string` Return the protocol property Return the protocol property	#
`public`	`transport(string\|null $type = null): string` Get/set the transport type for this protocol Get/set the transport type for this protocol	#
`public`	`options(array $options = []): array` Set the options for the protocol call Set the options for the protocol call	#
`public`	`getPacket(array $type = []): array` Return specific packet(s) Return specific packet(s)	#
`public`	`packetResponse(array\|null $response = null): array` Get/set the packet response Get/set the packet response	#
`public`	`hasChallenge(): bool` Determine whether or not this protocol has a challenge needed before querying Determine whether or not this protocol has a challenge needed before querying	#
`public`	`challengeParseAndApply(Buffer $challenge_buffer): bool` Parse the challenge response and add it to the buffer items that need it. This should be overloaded by extending class Parse the challenge response and add it to the buffer items that need it. This should be overloaded by extending class Overriden by `GameQ\Protocols\Gamespy3::challengeParseAndApply()` `GameQ\Protocols\Ffow::challengeParseAndApply()` `GameQ\Protocols\Source::challengeParseAndApply()`	#
`protected`	`challengeApply(string $challenge_string): bool` Apply the challenge string to all the packets that need it. Apply the challenge string to all the packets that need it.	#
`public`	`getNormalize(): array` Get the normalize settings for the protocol Get the normalize settings for the protocol	#
`public`	`beforeSend(Server $server)` Generic method to allow protocol classes to do work right before the query is sent Generic method to allow protocol classes to do work right before the query is sent Overriden by `GameQ\Protocols\Teamspeak3::beforeSend()` `GameQ\Protocols\Cfx::beforeSend()` `GameQ\Protocols\Raknet::beforeSend()` `GameQ\Protocols\Teamspeak2::beforeSend()` `GameQ\Protocols\Gtan::beforeSend()` `GameQ\Protocols\Gtar::beforeSend()` `GameQ\Protocols\Samp::beforeSend()`	#
`abstract public`	`processResponse(): mixed` Method called to process query response data. Each extending class has to have one of these functions. Method called to process query response data. Each extending class has to have one of these functions. Implemented by `GameQ\Protocols\Starmade::processResponse()` `GameQ\Protocols\Quake3::processResponse()` `GameQ\Protocols\Tibia::processResponse()` `GameQ\Protocols\Cs2d::processResponse()` `GameQ\Protocols\Teamspeak3::processResponse()` `GameQ\Protocols\Cfx::processResponse()` `GameQ\Protocols\Raknet::processResponse()` `GameQ\Protocols\Teeworlds::processResponse()` `GameQ\Protocols\Bfbc2::processResponse()` `GameQ\Protocols\Ase::processResponse()` `GameQ\Protocols\Teamspeak2::processResponse()` `GameQ\Protocols\Openttd::processResponse()` `GameQ\Protocols\Gamespy3::processResponse()` `GameQ\Protocols\Ventrilo::processResponse()` `GameQ\Protocols\Gamespy::processResponse()` `GameQ\Protocols\Etqw::processResponse()` `GameQ\Protocols\Gamespy2::processResponse()` `GameQ\Protocols\Quake2::processResponse()` `GameQ\Protocols\Bf3::processResponse()` `GameQ\Protocols\CFXPlayers::processResponse()` `GameQ\Protocols\Eco::processResponse()` `GameQ\Protocols\Gtan::processResponse()` `GameQ\Protocols\Gtar::processResponse()` `GameQ\Protocols\Tshock::processResponse()` `GameQ\Protocols\Lhmp::processResponse()` `GameQ\Protocols\Unreal2::processResponse()` `GameQ\Protocols\Doom3::processResponse()` `GameQ\Protocols\Ffow::processResponse()` `GameQ\Protocols\M2mp::processResponse()` `GameQ\Protocols\Samp::processResponse()` `GameQ\Protocols\Mumble::processResponse()` `GameQ\Protocols\Source::processResponse()`	#

Constants
`public`	`STATE_TESTING = 1` Constants for class states Constants for class states	#
`public`	`STATE_BETA = 2`	#
`public`	`STATE_STABLE = 3`	#
`public`	`STATE_DEPRECATED = 4`	#
`public`	`PACKET_ALL = 'all'` Constants for packet keys Constants for packet keys	#
`public`	`PACKET_BASIC = 'basic'`	#
`public`	`PACKET_CHALLENGE = 'challenge'`	#
`public`	`PACKET_CHANNELS = 'channels'`	#
`public`	`PACKET_DETAILS = 'details'`	#
`public`	`PACKET_INFO = 'info'`	#
`public`	`PACKET_PLAYERS = 'players'`	#
`public`	`PACKET_STATUS = 'status'`	#
`public`	`PACKET_RULES = 'rules'`	#
`public`	`PACKET_VERSION = 'version'`	#
`public`	`TRANSPORT_UDP = 'udp'` Transport constants Transport constants	#
`public`	`TRANSPORT_TCP = 'tcp'`	#
`public`	`TRANSPORT_SSL = 'ssl'`	#
`public`	`TRANSPORT_TLS = 'tls'`	#

Properties
`protected`		`$name = 'unknown'` Short name of the protocol Short name of the protocol	#
`protected`		`$name_long = 'unknown'` The longer, fancier name for the protocol The longer, fancier name for the protocol	#
`protected`		`$port_diff = 0` The difference between the client port and query port The difference between the client port and query port	#
`protected`		`$transport = self::TRANSPORT_UDP` The transport method to use to actually send the data Default is UDP The transport method to use to actually send the data Default is UDP	#
`protected`		`$protocol = 'unknown'` The protocol type used when querying the server The protocol type used when querying the server	#
`protected`		`$packets = []` Holds the valid packet types this protocol has available. Holds the valid packet types this protocol has available.	#
`protected`		`$responses = []` Holds the response headers and the method to use to process them. Holds the response headers and the method to use to process them.	#
`protected`		`$process_methods = []` Holds the list of methods to run when parsing the packet response(s) data. These methods should provide all the return… Holds the list of methods to run when parsing the packet response(s) data. These methods should provide all the return information.	#
`protected`		`$packets_response = []` The packet responses received The packet responses received	#
`protected`		`$result = null` Holds the instance of the result class Holds the instance of the result class	#
`protected`		`$options = []` Options for this protocol Options for this protocol	#
`protected`		`$state = self::STATE_STABLE` Define the state of this class Define the state of this class	#
`protected`		$normalize = [ 'general' => [ 'dedicated' => [ 'listenserver', 'dedic', 'bf2dedicated', 'netserverdedicated', 'bf2142dedicated', 'dedicated', ], 'gametype' => ['ggametype', 'sigametype', 'matchtype'], 'hostname' => ['svhostname', 'servername', 'siname', 'name'], 'mapname' => ['map', 'simap'], 'maxplayers' => ['svmaxclients', 'simaxplayers', 'maxclients', 'max_players'], 'mod' => ['game', 'gamedir', 'gamevariant'], 'numplayers' => ['clients', 'sinumplayers', 'num_players'], 'password' => ['protected', 'siusepass', 'sineedpass', 'pswrd', 'gneedpass', 'auth', 'passsord'], ], 'player' => [ 'name' => ['nick', 'player', 'playername', 'name'], 'kills' => ['kills'], 'deaths' => ['deaths'], 'score' => ['kills', 'frags', 'skill', 'score'], 'ping' => ['ping'], ], 'team' => ['name' => ['name', 'teamname', 'team_t'], 'score' => ['score', 'score_t']], ] Holds specific normalize settings Holds specific normalize settings	#
`protected`		`$join_link = ''` Quick join link Quick join link	#