Format
FinalYes
Constants
- FRAME_FOOTER : int = 0x6
- FRAME_HEADER_LENGTH : int = 5
- FRAME_ROW : int = 0x2
- HEADER_LENGTH : int = 6
- MAGIC : string = 'FLOE'
- TRAILER_LENGTH : int = 8
- VALUE_ABSENT : int = 0x3
- VALUE_ABSENT_BYTE : string = "\x03"
- VALUE_NULL : int = 0x0
- VALUE_NULL_BYTE : string = "\x00"
- VALUE_NULL_WITH_META : int = 0x2
- VALUE_NULL_WITH_META_BYTE : string = "\x02"
- VALUE_PRESENT : int = 0x1
- VALUE_PRESENT_BYTE : string = "\x01"
- VALUE_PRESENT_WITH_META : int = 0x4
- VALUE_PRESENT_WITH_META_BYTE : string = "\x04"
- VERSION : int = 0x2
Methods
- frame() : string
- header() : string
- metadataBytes() : string
- parseTrailer() : int
- readMetadata() : Metadata
- trailer() : string
- validateCodecId() : void
- validateHeader() : int
Constants
FRAME_FOOTER
public
int
FRAME_FOOTER
= 0x6
FRAME_HEADER_LENGTH
public
int
FRAME_HEADER_LENGTH
= 5
FRAME_ROW
public
int
FRAME_ROW
= 0x2
HEADER_LENGTH
public
int
HEADER_LENGTH
= 6
MAGIC
public
string
MAGIC
= 'FLOE'
TRAILER_LENGTH
public
int
TRAILER_LENGTH
= 8
VALUE_ABSENT
public
int
VALUE_ABSENT
= 0x3
VALUE_ABSENT_BYTE
public
string
VALUE_ABSENT_BYTE
= "\x03"
VALUE_NULL
public
int
VALUE_NULL
= 0x0
VALUE_NULL_BYTE
public
string
VALUE_NULL_BYTE
= "\x00"
VALUE_NULL_WITH_META
public
int
VALUE_NULL_WITH_META
= 0x2
VALUE_NULL_WITH_META_BYTE
public
string
VALUE_NULL_WITH_META_BYTE
= "\x02"
VALUE_PRESENT
public
int
VALUE_PRESENT
= 0x1
VALUE_PRESENT_BYTE
public
string
VALUE_PRESENT_BYTE
= "\x01"
VALUE_PRESENT_WITH_META
public
int
VALUE_PRESENT_WITH_META
= 0x4
VALUE_PRESENT_WITH_META_BYTE
public
string
VALUE_PRESENT_WITH_META_BYTE
= "\x04"
VERSION
public
int
VERSION
= 0x2
Methods
frame()
public
static frame(int $type, string $body) : string
Parameters
- $type : int
- $body : string
Return values
stringheader()
public
static header(int $flags) : string
Parameters
- $flags : int
Return values
stringmetadataBytes()
public
static metadataBytes(Metadata $metadata) : string
Parameters
- $metadata : Metadata
Tags
Return values
stringparseTrailer()
public
static parseTrailer(string $bytes) : int
Parameters
- $bytes : string
Tags
Return values
int —footer JSON length
readMetadata()
public
static readMetadata(string $body, int &$position) : Metadata
Parameters
- $body : string
- $position : int
Tags
Return values
Metadatatrailer()
public
static trailer(int $footerLength) : string
Parameters
- $footerLength : int
Return values
stringvalidateCodecId()
public
static validateCodecId(int $codecId) : void
Parameters
- $codecId : int
Tags
validateHeader()
public
static validateHeader(string $bytes) : int
Parameters
- $bytes : string
Tags
Return values
int —header flags byte