mirror of
https://github.com/pmmp/BedrockProtocol.git
synced 2025-02-23 22:05:07 +00:00
80e3a828b6
since a while ago, we're anyway just discarding the internal buffer anyway when the packet is repeatedly encoded, so this doesn't serve any advantage anymore. We do need a system to be able to reuse encoded packet buffers, but right now we're not reusing them anyway.
130 lines
3.5 KiB
PHP
130 lines
3.5 KiB
PHP
<?php
|
|
|
|
/*
|
|
*
|
|
* ____ _ _ __ __ _ __ __ ____
|
|
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
|
|
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
|
|
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
|
|
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* @author PocketMine Team
|
|
* @link http://www.pocketmine.net/
|
|
*
|
|
*
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace pocketmine\network\mcpe\protocol;
|
|
|
|
#include <rules/DataPacket.h>
|
|
|
|
use pocketmine\network\mcpe\protocol\serializer\PacketSerializer;
|
|
use pocketmine\utils\BinaryDataException;
|
|
use function get_class;
|
|
|
|
abstract class DataPacket implements Packet{
|
|
|
|
public const NETWORK_ID = 0;
|
|
|
|
public const PID_MASK = 0x3ff; //10 bits
|
|
|
|
private const SUBCLIENT_ID_MASK = 0x03; //2 bits
|
|
private const SENDER_SUBCLIENT_ID_SHIFT = 10;
|
|
private const RECIPIENT_SUBCLIENT_ID_SHIFT = 12;
|
|
|
|
/** @var int */
|
|
public $senderSubId = 0;
|
|
/** @var int */
|
|
public $recipientSubId = 0;
|
|
|
|
public function pid() : int{
|
|
return $this::NETWORK_ID;
|
|
}
|
|
|
|
public function getName() : string{
|
|
return (new \ReflectionClass($this))->getShortName();
|
|
}
|
|
|
|
public function canBeSentBeforeLogin() : bool{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @throws PacketDecodeException
|
|
*/
|
|
final public function decode(PacketSerializer $in) : void{
|
|
try{
|
|
$this->decodeHeader($in);
|
|
$this->decodePayload($in);
|
|
}catch(BinaryDataException | PacketDecodeException $e){
|
|
throw PacketDecodeException::wrap($e, $this->getName());
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @throws BinaryDataException
|
|
* @throws \UnexpectedValueException
|
|
*/
|
|
protected function decodeHeader(PacketSerializer $in) : void{
|
|
$header = $in->getUnsignedVarInt();
|
|
$pid = $header & self::PID_MASK;
|
|
if($pid !== static::NETWORK_ID){
|
|
//TODO: this means a logical error in the code, but how to prevent it from happening?
|
|
throw new \UnexpectedValueException("Expected " . static::NETWORK_ID . " for packet ID, got $pid");
|
|
}
|
|
$this->senderSubId = ($header >> self::SENDER_SUBCLIENT_ID_SHIFT) & self::SUBCLIENT_ID_MASK;
|
|
$this->recipientSubId = ($header >> self::RECIPIENT_SUBCLIENT_ID_SHIFT) & self::SUBCLIENT_ID_MASK;
|
|
|
|
}
|
|
|
|
/**
|
|
* Decodes the packet body, without the packet ID or other generic header fields.
|
|
*
|
|
* @throws PacketDecodeException
|
|
* @throws BinaryDataException
|
|
*/
|
|
abstract protected function decodePayload(PacketSerializer $in) : void;
|
|
|
|
final public function encode(PacketSerializer $out) : void{
|
|
$this->encodeHeader($out);
|
|
$this->encodePayload($out);
|
|
}
|
|
|
|
protected function encodeHeader(PacketSerializer $out) : void{
|
|
$out->putUnsignedVarInt(
|
|
static::NETWORK_ID |
|
|
($this->senderSubId << self::SENDER_SUBCLIENT_ID_SHIFT) |
|
|
($this->recipientSubId << self::RECIPIENT_SUBCLIENT_ID_SHIFT)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Encodes the packet body, without the packet ID or other generic header fields.
|
|
*/
|
|
abstract protected function encodePayload(PacketSerializer $out) : void;
|
|
|
|
/**
|
|
* @param string $name
|
|
*
|
|
* @return mixed
|
|
*/
|
|
public function __get($name){
|
|
throw new \Error("Undefined property: " . get_class($this) . "::\$" . $name);
|
|
}
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param mixed $value
|
|
*/
|
|
public function __set($name, $value) : void{
|
|
throw new \Error("Undefined property: " . get_class($this) . "::\$" . $name);
|
|
}
|
|
}
|