1
0
mirror of https://github.com/xPaw/PHP-Source-Query.git synced 2026-06-08 01:46:00 +02:00

Document additional throws and fix return

This commit is contained in:
Pavel Djundik
2015-10-18 22:06:52 +03:00
parent c74a5dcc99
commit 418dfd4050
+6 -3
View File
@@ -192,6 +192,7 @@
* Sends ping packet to the server * Sends ping packet to the server
* NOTE: This may not work on some games (TF2 for example) * NOTE: This may not work on some games (TF2 for example)
* *
* @throws InvalidPacketException
* @throws SocketException * @throws SocketException
* *
* @return bool True on success, false on failure * @return bool True on success, false on failure
@@ -483,10 +484,10 @@
* *
* @param $Header * @param $Header
* @param $ExpectedResult * @param $ExpectedResult
* *
* @throws InvalidPacketException * @throws InvalidPacketException
* *
* @return bool True if all went well, false if server uses old GoldSource protocol, and it already contains answer * @return int Returns one of the GETCHALLENGE_* constants
*/ */
private function GetChallenge( $Header, $ExpectedResult ) private function GetChallenge( $Header, $ExpectedResult )
{ {
@@ -536,6 +537,7 @@
* @param string $Password Rcon Password * @param string $Password Rcon Password
* *
* @throws AuthenticationException * @throws AuthenticationException
* @throws InvalidPacketException
* @throws SocketException * @throws SocketException
* *
* @return bool True on success, false on failure * @return bool True on success, false on failure
@@ -576,6 +578,7 @@
* @param string $Command Command to execute * @param string $Command Command to execute
* *
* @throws AuthenticationException * @throws AuthenticationException
* @throws InvalidPacketException
* @throws SocketException * @throws SocketException
* *
* @return string|bool Answer from server in string, false on failure * @return string|bool Answer from server in string, false on failure