API Documentation
\

\TProtocol

Protocol base class module.

Summary

Methods
Properties
Constants
getTransport()
writeMessageBegin()
writeMessageEnd()
writeStructBegin()
writeStructEnd()
writeFieldBegin()
writeFieldEnd()
writeFieldStop()
writeMapBegin()
writeMapEnd()
writeListBegin()
writeListEnd()
writeSetBegin()
writeSetEnd()
writeBool()
writeByte()
writeI16()
writeI32()
writeI64()
writeDouble()
writeString()
readMessageBegin()
readMessageEnd()
readStructBegin()
readStructEnd()
readFieldBegin()
readFieldEnd()
readMapBegin()
readMapEnd()
readListBegin()
readListEnd()
readSetBegin()
readSetEnd()
readBool()
readByte()
readI16()
readI32()
readI64()
readDouble()
readString()
skip()
skipBinary()
$TBINARYPROTOCOLACCELERATED
No constants found
__construct()
$trans_
N/A
No private methods found
No private properties found
N/A

Properties

$TBINARYPROTOCOLACCELERATED

$TBINARYPROTOCOLACCELERATED :

Type

$trans_

$trans_ : \TTransport

Underlying transport

Type

\TTransport

Methods

getTransport()

getTransport() : \TTransport

Accessor for transport

Returns

\TTransport

writeMessageBegin()

writeMessageBegin(string  $name, integer  $type, integer  $seqid)

Writes the message header

Parameters

string $name

Function name
integer $type

message type TMessageType::CALL or TMessageType::REPLY
integer $seqid

The sequence id of this message

writeMessageEnd()

writeMessageEnd()

Close the message

writeStructBegin()

writeStructBegin(string  $name) : integer

Writes a struct header.

Parameters

string $name

Struct name

Throws

\TException

on write error

Returns

integer —

How many bytes written

writeStructEnd()

writeStructEnd() : integer

Close a struct.

Throws

\TException

on write error

Returns

integer —

How many bytes written

writeFieldBegin()

writeFieldBegin(  $fieldName,   $fieldType,   $fieldId)

Parameters

$fieldName
$fieldType
$fieldId

writeFieldEnd()

writeFieldEnd()

writeFieldStop()

writeFieldStop()

writeMapBegin()

writeMapBegin(  $keyType,   $valType,   $size)

Parameters

$keyType
$valType
$size

writeMapEnd()

writeMapEnd()

writeListBegin()

writeListBegin(  $elemType,   $size)

Parameters

$elemType
$size

writeListEnd()

writeListEnd()

writeSetBegin()

writeSetBegin(  $elemType,   $size)

Parameters

$elemType
$size

writeSetEnd()

writeSetEnd()

writeBool()

writeBool(  $bool)

Parameters

$bool

writeByte()

writeByte(  $byte)

Parameters

$byte

writeI16()

writeI16(  $i16)

Parameters

$i16

writeI32()

writeI32(  $i32)

Parameters

$i32

writeI64()

writeI64(  $i64)

Parameters

$i64

writeDouble()

writeDouble(  $dub)

Parameters

$dub

writeString()

writeString(  $str)

Parameters

$str

readMessageBegin()

readMessageBegin(string  $name, integer  $type,   $seqid)

Reads the message header

Parameters

string $name

Function name
integer $type

message type TMessageType::CALL or TMessageType::REPLY
$seqid

readMessageEnd()

readMessageEnd()

Read the close of message

readStructBegin()

readStructBegin(  $name)

Parameters

$name

readStructEnd()

readStructEnd()

readFieldBegin()

readFieldBegin(  $name,   $fieldType,   $fieldId)

Parameters

$name
$fieldType
$fieldId

readFieldEnd()

readFieldEnd()

readMapBegin()

readMapBegin(  $keyType,   $valType,   $size)

Parameters

$keyType
$valType
$size

readMapEnd()

readMapEnd()

readListBegin()

readListBegin(  $elemType,   $size)

Parameters

$elemType
$size

readListEnd()

readListEnd()

readSetBegin()

readSetBegin(  $elemType,   $size)

Parameters

$elemType
$size

readSetEnd()

readSetEnd()

readBool()

readBool(  $bool)

Parameters

$bool

readByte()

readByte(  $byte)

Parameters

$byte

readI16()

readI16(  $i16)

Parameters

$i16

readI32()

readI32(  $i32)

Parameters

$i32

readI64()

readI64(  $i64)

Parameters

$i64

readDouble()

readDouble(  $dub)

Parameters

$dub

readString()

readString(  $str)

Parameters

$str

skip()

skip(\TType  $type)

The skip function is a utility to parse over unrecognized date without causing corruption.

Parameters

\TType $type

What type is it

skipBinary()

skipBinary(\TTransport  $itrans, integer  $type)

Utility for skipping binary data

Parameters

\TTransport $itrans

TTransport object
integer $type

Field type

__construct()

__construct(  $trans)

Constructor

Parameters

$trans