EncapsulatedPacket Class Reference

Public Member Functions
	getTotalLength ()
	toBinary ($internal=false)
	__toString ()

Static Public Member Functions
static	fromBinary ($binary, $internal=false, &$offset=null)

Data Fields
	$reliability
	$hasSplit = false
	$length = 0
	$messageIndex = null
	$orderIndex = null
	$orderChannel = null
	$splitCount = null
	$splitID = null
	$splitIndex = null
	$buffer
	$needACK = false
	$identifierACK = null

Member Function Documentation

__toString()

__toString

(

)

                                {
        return $this->toBinary();
    }

fromBinary()

static fromBinary (   $binary,   $internal = false, &  $offset = null  )

static

Parameters

string	$binary
bool	$internal
int	&$offset

Returns

EncapsulatedPacket

                                                                                  {

        $packet = new EncapsulatedPacket();

        $flags = ord($binary{0});
        $packet->reliability = $reliability = ($flags & 0b11100000) >> 5;
        $packet->hasSplit = $hasSplit = ($flags & 0b00010000) > 0;
        if($internal){
            $length = Binary::readInt(substr($binary, 1, 4));
            $packet->identifierACK = Binary::readInt(substr($binary, 5, 4));
            $offset = 9;
        }else{
            $length = (int) ceil(Binary::readShort(substr($binary, 1, 2)) / 8);
            $offset = 3;
            $packet->identifierACK = null;
        }

        if($reliability > PacketReliability::UNRELIABLE){
            if($reliability >= PacketReliability::RELIABLE and $reliability !== PacketReliability::UNRELIABLE_WITH_ACK_RECEIPT){
                $packet->messageIndex = Binary::readLTriad(substr($binary, $offset, 3));
                $offset += 3;
            }

            if($reliability <= PacketReliability::RELIABLE_SEQUENCED and $reliability !== PacketReliability::RELIABLE){
                $packet->orderIndex = Binary::readLTriad(substr($binary, $offset, 3));
                $offset += 3;
                $packet->orderChannel = ord($binary{$offset++});
            }
        }

        if($hasSplit){
            $packet->splitCount = Binary::readInt(substr($binary, $offset, 4));
            $offset += 4;
            $packet->splitID = Binary::readShort(substr($binary, $offset, 2));
            $offset += 2;
            $packet->splitIndex = Binary::readInt(substr($binary, $offset, 4));
            $offset += 4;
        }

        $packet->buffer = substr($binary, $offset, $length);
        $offset += $length;

        return $packet;
    }

getTotalLength()

getTotalLength

(

)

                                    {
        return 3 + strlen($this->buffer) + ($this->messageIndex !== null ? 3 : 0) + ($this->orderIndex !== null ? 4 : 0) + ($this->hasSplit ? 10 : 0);
    }

toBinary()

toBinary

(

$internal = false

)

Parameters

bool

$internal

Returns

string

                                               {
        return
            chr(($this->reliability << 5) | ($this->hasSplit ? 0b00010000 : 0)) .
            ($internal ? Binary::writeInt(strlen($this->buffer)) . Binary::writeInt($this->identifierACK) : Binary::writeShort(strlen($this->buffer) << 3)) .
            ($this->reliability > PacketReliability::UNRELIABLE ?
                (($this->reliability >= PacketReliability::RELIABLE and $this->reliability !== PacketReliability::UNRELIABLE_WITH_ACK_RECEIPT) ? Binary::writeLTriad($this->messageIndex) : "") .
                (($this->reliability <= PacketReliability::RELIABLE_SEQUENCED and $this->reliability !== PacketReliability::RELIABLE) ? Binary::writeLTriad($this->orderIndex) . chr($this->orderChannel) : "")
                : ""
            ) .
            ($this->hasSplit ? Binary::writeInt($this->splitCount) . Binary::writeShort($this->splitID) . Binary::writeInt($this->splitIndex) : "")
            . $this->buffer;
    }

Field Documentation

$buffer

$buffer

$hasSplit

$hasSplit = false

$identifierACK

$identifierACK = null

$length

$length = 0

$messageIndex

$messageIndex = null

$needACK

$needACK = false

$orderChannel

$orderChannel = null

$orderIndex

$orderIndex = null

$reliability

$reliability

$splitCount

$splitCount = null

$splitID

$splitID = null

$splitIndex

$splitIndex = null

---

The documentation for this class was generated from the following file:

• src/raklib/protocol/EncapsulatedPacket.php