From b42966f61be091ed6ee0c3530c901d2b6801099f Mon Sep 17 00:00:00 2001 From: "Dylan K. Taylor" Date: Sat, 18 Jan 2020 19:35:01 +0000 Subject: [PATCH] network: explicitly specify @return void --- .../network/AdvancedSourceInterface.php | 8 ++++++ src/pocketmine/network/Network.php | 28 +++++++++++++++++++ src/pocketmine/network/SourceInterface.php | 10 +++++++ .../network/mcpe/NetworkBinaryStream.php | 5 ++++ .../network/mcpe/NetworkSession.php | 5 ++++ .../network/mcpe/RakLibInterface.php | 2 ++ .../mcpe/protocol/AdventureSettingsPacket.php | 6 ++++ .../network/mcpe/protocol/BatchPacket.php | 7 +++++ .../mcpe/protocol/CommandOutputPacket.php | 5 ++++ .../mcpe/protocol/CraftingDataPacket.php | 15 ++++++++++ .../network/mcpe/protocol/PacketPool.php | 5 ++++ .../protocol/types/NetworkInventoryAction.php | 1 + src/pocketmine/network/query/QueryHandler.php | 13 +++++++++ src/pocketmine/network/rcon/RCON.php | 6 ++++ src/pocketmine/network/rcon/RCONInstance.php | 6 ++++ 15 files changed, 122 insertions(+) diff --git a/src/pocketmine/network/AdvancedSourceInterface.php b/src/pocketmine/network/AdvancedSourceInterface.php index 44bf863ed..a43202691 100644 --- a/src/pocketmine/network/AdvancedSourceInterface.php +++ b/src/pocketmine/network/AdvancedSourceInterface.php @@ -37,6 +37,8 @@ interface AdvancedSourceInterface extends SourceInterface{ * * @param string $address * @param int $timeout Seconds + * + * @return void */ public function blockAddress(string $address, int $timeout = 300); @@ -44,11 +46,15 @@ interface AdvancedSourceInterface extends SourceInterface{ * Unblocks a previously-blocked address. * * @param string $address + * + * @return void */ public function unblockAddress(string $address); /** * @param Network $network + * + * @return void */ public function setNetwork(Network $network); @@ -58,6 +64,8 @@ interface AdvancedSourceInterface extends SourceInterface{ * @param string $address * @param int $port * @param string $payload + * + * @return void */ public function sendRawPacket(string $address, int $port, string $payload); diff --git a/src/pocketmine/network/Network.php b/src/pocketmine/network/Network.php index 22b73a109..0bc3f1be4 100644 --- a/src/pocketmine/network/Network.php +++ b/src/pocketmine/network/Network.php @@ -64,6 +64,8 @@ class Network{ /** * @param float $upload * @param float $download + * + * @return void */ public function addStatistics($upload, $download){ $this->upload += $upload; @@ -84,6 +86,9 @@ class Network{ return $this->download; } + /** + * @return void + */ public function resetStatistics(){ $this->upload = 0; $this->download = 0; @@ -96,6 +101,9 @@ class Network{ return $this->interfaces; } + /** + * @return void + */ public function processInterfaces(){ foreach($this->interfaces as $interface){ $interface->process(); @@ -105,6 +113,8 @@ class Network{ /** * @deprecated * @param SourceInterface $interface + * + * @return void */ public function processInterface(SourceInterface $interface) : void{ $interface->process(); @@ -112,6 +122,8 @@ class Network{ /** * @param SourceInterface $interface + * + * @return void */ public function registerInterface(SourceInterface $interface){ $ev = new NetworkInterfaceRegisterEvent($interface); @@ -129,6 +141,8 @@ class Network{ /** * @param SourceInterface $interface + * + * @return void */ public function unregisterInterface(SourceInterface $interface){ (new NetworkInterfaceUnregisterEvent($interface))->call(); @@ -139,6 +153,8 @@ class Network{ * Sets the server name shown on each interface Query * * @param string $name + * + * @return void */ public function setName(string $name){ $this->name = $name; @@ -154,6 +170,9 @@ class Network{ return $this->name; } + /** + * @return void + */ public function updateName(){ foreach($this->interfaces as $interface){ $interface->setName($this->name); @@ -171,6 +190,8 @@ class Network{ * @param string $address * @param int $port * @param string $payload + * + * @return void */ public function sendPacket(string $address, int $port, string $payload){ foreach($this->advancedInterfaces as $interface){ @@ -183,6 +204,8 @@ class Network{ * * @param string $address * @param int $timeout + * + * @return void */ public function blockAddress(string $address, int $timeout = 300){ foreach($this->advancedInterfaces as $interface){ @@ -190,6 +213,11 @@ class Network{ } } + /** + * @param string $address + * + * @return void + */ public function unblockAddress(string $address){ foreach($this->advancedInterfaces as $interface){ $interface->unblockAddress($address); diff --git a/src/pocketmine/network/SourceInterface.php b/src/pocketmine/network/SourceInterface.php index 75e14c98b..cb6f6f42c 100644 --- a/src/pocketmine/network/SourceInterface.php +++ b/src/pocketmine/network/SourceInterface.php @@ -36,6 +36,8 @@ interface SourceInterface{ /** * Performs actions needed to start the interface after it is registered. + * + * @return void */ public function start(); @@ -56,11 +58,15 @@ interface SourceInterface{ * * @param Player $player * @param string $reason + * + * @return void */ public function close(Player $player, string $reason = "unknown reason"); /** * @param string $name + * + * @return void */ public function setName(string $name); @@ -71,12 +77,16 @@ interface SourceInterface{ /** * Gracefully shuts down the network interface. + * + * @return void */ public function shutdown(); /** * @deprecated * Shuts down the network interface in an emergency situation, such as due to a crash. + * + * @return void */ public function emergencyShutdown(); diff --git a/src/pocketmine/network/mcpe/NetworkBinaryStream.php b/src/pocketmine/network/mcpe/NetworkBinaryStream.php index 71f4fd153..026d235e3 100644 --- a/src/pocketmine/network/mcpe/NetworkBinaryStream.php +++ b/src/pocketmine/network/mcpe/NetworkBinaryStream.php @@ -103,6 +103,11 @@ class NetworkBinaryStream extends BinaryStream{ return new SkinData($skinId, $skinResourcePatch, $skinData, $animations, $capeData, $geometryData, $animationData, $premium, $persona, $capeOnClassic, $capeId); } + /** + * @param SkinData $skin + * + * @return void + */ public function putSkin(SkinData $skin){ $this->putString($skin->getSkinId()); $this->putString($skin->getResourcePatch()); diff --git a/src/pocketmine/network/mcpe/NetworkSession.php b/src/pocketmine/network/mcpe/NetworkSession.php index 19a5a14ba..ad0a3f553 100644 --- a/src/pocketmine/network/mcpe/NetworkSession.php +++ b/src/pocketmine/network/mcpe/NetworkSession.php @@ -169,6 +169,11 @@ use pocketmine\network\mcpe\protocol\VideoStreamConnectPacket; abstract class NetworkSession{ + /** + * @param DataPacket $packet + * + * @return void + */ abstract public function handleDataPacket(DataPacket $packet); public function handleLogin(LoginPacket $packet) : bool{ diff --git a/src/pocketmine/network/mcpe/RakLibInterface.php b/src/pocketmine/network/mcpe/RakLibInterface.php index 6312bac5b..0b73291df 100644 --- a/src/pocketmine/network/mcpe/RakLibInterface.php +++ b/src/pocketmine/network/mcpe/RakLibInterface.php @@ -219,6 +219,8 @@ class RakLibInterface implements ServerInstance, AdvancedSourceInterface{ /** * @param bool $name + * + * @return void */ public function setPortCheck($name){ $this->interface->sendOption("portChecking", (bool) $name); diff --git a/src/pocketmine/network/mcpe/protocol/AdventureSettingsPacket.php b/src/pocketmine/network/mcpe/protocol/AdventureSettingsPacket.php index 8196f6d3a..ff9444ad6 100644 --- a/src/pocketmine/network/mcpe/protocol/AdventureSettingsPacket.php +++ b/src/pocketmine/network/mcpe/protocol/AdventureSettingsPacket.php @@ -102,6 +102,12 @@ class AdventureSettingsPacket extends DataPacket{ return ($this->flags & $flag) !== 0; } + /** + * @param int $flag + * @param bool $value + * + * @return void + */ public function setFlag(int $flag, bool $value){ if($flag & self::BITFLAG_SECOND_SET){ $flagSet =& $this->flags2; diff --git a/src/pocketmine/network/mcpe/protocol/BatchPacket.php b/src/pocketmine/network/mcpe/protocol/BatchPacket.php index b49ebb8ef..bc9971698 100644 --- a/src/pocketmine/network/mcpe/protocol/BatchPacket.php +++ b/src/pocketmine/network/mcpe/protocol/BatchPacket.php @@ -77,6 +77,8 @@ class BatchPacket extends DataPacket{ /** * @param DataPacket $packet + * + * @return void */ public function addPacket(DataPacket $packet){ if(!$packet->canBeBatched()){ @@ -107,6 +109,11 @@ class BatchPacket extends DataPacket{ return $this->compressionLevel; } + /** + * @param int $level + * + * @return void + */ public function setCompressionLevel(int $level){ $this->compressionLevel = $level; } diff --git a/src/pocketmine/network/mcpe/protocol/CommandOutputPacket.php b/src/pocketmine/network/mcpe/protocol/CommandOutputPacket.php index e7c3ff655..7dcc99225 100644 --- a/src/pocketmine/network/mcpe/protocol/CommandOutputPacket.php +++ b/src/pocketmine/network/mcpe/protocol/CommandOutputPacket.php @@ -86,6 +86,11 @@ class CommandOutputPacket extends DataPacket{ } } + /** + * @param CommandOutputMessage $message + * + * @return void + */ protected function putCommandMessage(CommandOutputMessage $message){ $this->putBool($message->isInternal); $this->putString($message->messageId); diff --git a/src/pocketmine/network/mcpe/protocol/CraftingDataPacket.php b/src/pocketmine/network/mcpe/protocol/CraftingDataPacket.php index 2382f9c87..6af158972 100644 --- a/src/pocketmine/network/mcpe/protocol/CraftingDataPacket.php +++ b/src/pocketmine/network/mcpe/protocol/CraftingDataPacket.php @@ -238,14 +238,29 @@ class CraftingDataPacket extends DataPacket{ return $result; } + /** + * @param ShapelessRecipe $recipe + * + * @return void + */ public function addShapelessRecipe(ShapelessRecipe $recipe){ $this->entries[] = $recipe; } + /** + * @param ShapedRecipe $recipe + * + * @return void + */ public function addShapedRecipe(ShapedRecipe $recipe){ $this->entries[] = $recipe; } + /** + * @param FurnaceRecipe $recipe + * + * @return void + */ public function addFurnaceRecipe(FurnaceRecipe $recipe){ $this->entries[] = $recipe; } diff --git a/src/pocketmine/network/mcpe/protocol/PacketPool.php b/src/pocketmine/network/mcpe/protocol/PacketPool.php index 3ca054104..3b01e4894 100644 --- a/src/pocketmine/network/mcpe/protocol/PacketPool.php +++ b/src/pocketmine/network/mcpe/protocol/PacketPool.php @@ -30,6 +30,9 @@ class PacketPool{ /** @var \SplFixedArray */ protected static $pool = null; + /** + * @return void + */ public static function init(){ static::$pool = new \SplFixedArray(256); @@ -179,6 +182,8 @@ class PacketPool{ /** * @param DataPacket $packet + * + * @return void */ public static function registerPacket(DataPacket $packet){ static::$pool[$packet->pid()] = clone $packet; diff --git a/src/pocketmine/network/mcpe/protocol/types/NetworkInventoryAction.php b/src/pocketmine/network/mcpe/protocol/types/NetworkInventoryAction.php index 10591a67e..235c7652a 100644 --- a/src/pocketmine/network/mcpe/protocol/types/NetworkInventoryAction.php +++ b/src/pocketmine/network/mcpe/protocol/types/NetworkInventoryAction.php @@ -115,6 +115,7 @@ class NetworkInventoryAction{ /** * @param InventoryTransactionPacket $packet + * @return void */ public function write(InventoryTransactionPacket $packet){ $packet->putUnsignedVarInt($this->sourceType); diff --git a/src/pocketmine/network/query/QueryHandler.php b/src/pocketmine/network/query/QueryHandler.php index 2c605b027..cda79cc26 100644 --- a/src/pocketmine/network/query/QueryHandler.php +++ b/src/pocketmine/network/query/QueryHandler.php @@ -76,11 +76,16 @@ class QueryHandler{ /** * @deprecated + * + * @return void */ public function regenerateInfo(){ } + /** + * @return void + */ public function regenerateToken(){ $this->lastToken = $this->token; $this->token = random_bytes(16); @@ -90,6 +95,14 @@ class QueryHandler{ return Binary::readInt(substr(hash("sha512", $salt . ":" . $token, true), 7, 4)); } + /** + * @param AdvancedSourceInterface $interface + * @param string $address + * @param int $port + * @param string $packet + * + * @return void + */ public function handle(AdvancedSourceInterface $interface, string $address, int $port, string $packet){ $offset = 2; $packetType = ord($packet[$offset++]); diff --git a/src/pocketmine/network/rcon/RCON.php b/src/pocketmine/network/rcon/RCON.php index 01e14043e..989503ed7 100644 --- a/src/pocketmine/network/rcon/RCON.php +++ b/src/pocketmine/network/rcon/RCON.php @@ -100,6 +100,9 @@ class RCON{ $this->server->getLogger()->info("RCON running on $addr:$port"); } + /** + * @return void + */ public function stop(){ $this->instance->close(); socket_write($this->ipcMainSocket, "\x00"); //make select() return @@ -110,6 +113,9 @@ class RCON{ @socket_close($this->ipcThreadSocket); } + /** + * @return void + */ public function check(){ $response = new RemoteConsoleCommandSender(); $command = $this->instance->cmd; diff --git a/src/pocketmine/network/rcon/RCONInstance.php b/src/pocketmine/network/rcon/RCONInstance.php index 1164bbb33..f2a2acf46 100644 --- a/src/pocketmine/network/rcon/RCONInstance.php +++ b/src/pocketmine/network/rcon/RCONInstance.php @@ -159,10 +159,16 @@ class RCONInstance extends Thread{ return true; } + /** + * @return void + */ public function close(){ $this->stop = true; } + /** + * @return void + */ public function run(){ $this->registerClassLoader();