Packet Class Reference

Public Member Functions
	encode ()
	decode ()
	clean ()

Data Fields
	$buffer
	$sendTime

Static Public Attributes
static	$ID = -1

Protected Member Functions
	get ($len)
	getLong ($signed=true)
	getInt ()
	getShort ($signed=true)
	getTriad ()
	getLTriad ()
	getByte ()
	getString ()
	getAddress (&$addr, &$port, &$version=null)
	feof ()
	put ($str)
	putLong ($v)
	putInt ($v)
	putShort ($v)
	putTriad ($v)
	putLTriad ($v)
	putByte ($v)
	putString ($v)
	putAddress ($addr, $port, $version=4)

Protected Attributes
	$offset = 0

Member Function Documentation

clean()

clean

(

)

                           {
        $this->buffer = null;
        $this->offset = 0;
        $this->sendTime = null;
        return $this;
    }

decode()

decode

(

)

                            {
        $this->offset = 1;
    }

encode()

encode

(

)

                            {
        $this->buffer = chr(static::$ID);
    }

feof()

feof ( )

protected

                             {
        return !isset($this->buffer{$this->offset});
    }

get()

get (   $len )

protected

                                {
        if($len < 0){
            $this->offset = strlen($this->buffer) - 1;

            return "";
        }elseif($len === true){
            return substr($this->buffer, $this->offset);
        }

        return $len === 1 ? $this->buffer{$this->offset++} : substr($this->buffer, ($this->offset += $len) - $len, $len);
    }

getAddress()

getAddress ( &  $addr, &  $port, &  $version = null  )

protected

                                                                   {
        $version = $this->getByte();
        if($version === 4){
            $addr = ((~$this->getByte()) & 0xff) .".". ((~$this->getByte()) & 0xff) .".". ((~$this->getByte()) & 0xff) .".". ((~$this->getByte()) & 0xff);
            $port = $this->getShort(false);
        }else{
            //TODO: IPv6
        }
    }

getByte()

getByte ( )

protected

                                {
        return ord($this->buffer{$this->offset++});
    }

getInt()

getInt ( )

protected

                               {
        return Binary::readInt($this->get(4));
    }

getLong()

getLong (   $signed = true )

protected

                                              {
        return Binary::readLong($this->get(8), $signed);
    }

getLTriad()

getLTriad ( )

protected

                                  {
        return Binary::readLTriad($this->get(3));
    }

getShort()

getShort (   $signed = true )

protected

                                               {
        return $signed ? Binary::readSignedShort($this->get(2)) : Binary::readShort($this->get(2));
    }

getString()

getString ( )

protected

                                  {
        return $this->get($this->getShort());
    }

getTriad()

getTriad ( )

protected

                                 {
        return Binary::readTriad($this->get(3));
    }

put()

put (   $str )

protected

                                {
        $this->buffer .= $str;
    }

putAddress()

putAddress (   $addr,   $port,   $version = 4  )

protected

                                                             {
        $this->putByte($version);
        if($version === 4){
            foreach(explode(".", $addr) as $b){
                $this->putByte((~((int) $b)) & 0xff);
            }
            $this->putShort($port);
        }else{
            //IPv6
        }
    }

putByte()

putByte (   $v )

protected

                                  {
        $this->buffer .= chr($v);
    }

putInt()

putInt (   $v )

protected

                                 {
        $this->buffer .= Binary::writeInt($v);
    }

putLong()

putLong (   $v )

protected

                                  {
        $this->buffer .= Binary::writeLong($v);
    }

putLTriad()

putLTriad (   $v )

protected

                                    {
        $this->buffer .= Binary::writeLTriad($v);
    }

putShort()

putShort (   $v )

protected

                                   {
        $this->buffer .= Binary::writeShort($v);
    }

putString()

putString (   $v )

protected

                                    {
        $this->putShort(strlen($v));
        $this->put($v);
    }

putTriad()

putTriad (   $v )

protected

                                   {
        $this->buffer .= Binary::writeTriad($v);
    }

Field Documentation

$buffer

$buffer

$ID

$ID = -1

static

$offset

$offset = 0

protected

$sendTime

$sendTime

---

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

• src/raklib/protocol/Packet.php