Documentation

TranscoderFlags
in package

Table of Contents

COMPRESSION_NONE  = 0
No compression is being used
DATA_FORMAT_BINARY  = 3
Store as raw binary format
DATA_FORMAT_JSON  = 2
Encode as JSON
DATA_FORMAT_PRIVATE  = 1
Used for SDK specific encodings
DATA_FORMAT_RESERVED  = 0
Reserved bit position to avoid zeroing out upper 8 bits
DATA_FORMAT_STRING  = 4
Store as a UTF8 string
TYPE_CODE_NONE  = 0
No custom type is being associated
$compression  : int
$dataFormat  : int
$typeCode  : int
__construct()  : mixed
compression()  : int
dataFormat()  : int
decode()  : TranscoderFlags
Parses network representation of the flags
encode()  : int
isJson()  : bool
typeCode()  : int

Constants

COMPRESSION_NONE

No compression is being used

public mixed COMPRESSION_NONE = 0

DATA_FORMAT_BINARY

Store as raw binary format

public mixed DATA_FORMAT_BINARY = 3

DATA_FORMAT_PRIVATE

Used for SDK specific encodings

public mixed DATA_FORMAT_PRIVATE = 1

DATA_FORMAT_RESERVED

Reserved bit position to avoid zeroing out upper 8 bits

public mixed DATA_FORMAT_RESERVED = 0

DATA_FORMAT_STRING

Store as a UTF8 string

public mixed DATA_FORMAT_STRING = 4

TYPE_CODE_NONE

No custom type is being associated

public mixed TYPE_CODE_NONE = 0

Properties

Methods

__construct()

public __construct(int $dataFormat[, int $compression = self::COMPRESSION_NONE ][, int $typeCode = self::TYPE_CODE_NONE ]) : mixed
Parameters
$dataFormat : int

data format tag, portable across SDKs

$compression : int = self::COMPRESSION_NONE

compression tag, SDK-specific

$typeCode : int = self::TYPE_CODE_NONE

type code, SDK-specific

Tags
since
4.0.0
Return values
mixed —

compression()

public compression() : int
Tags
since
4.0.0
Return values
int —

dataFormat()

public dataFormat() : int
Tags
since
4.0.0
Return values
int —

encode()

public encode() : int
Tags
since
4.0.0
Return values
int —

network representation of the flags

isJson()

public isJson() : bool
Tags
since
4.0.0
Return values
bool —

true if the data format specifies portable JSON encoding

typeCode()

public typeCode() : int
Tags
since
4.0.0
Return values
int — 

        

        
    




    

    

                

    

        

            
Search results