Protocol

Less than 1 minute

Protocol

Hazaar Application Protocol Class

The Application Protocol is a simple protocol developed to allow communication between parts of the Hazaar framework over the wire or other IO interfaces. It allows common information to be encoded/decoded between endpoints.

Properties

typeCodes

public array $typeCodes

sid

private string $sid

lastError

private string $lastError

encoded

private bool $encoded

Methods

__construct

public  __construct({Array})

Parameters

Parameter	Type	Description
`$sid`	`string`
`$encoded`	`bool`

getLastError

public  getLastError({Array})

encoded

public  encoded({Array})

check

Checks that a protocol message type is valid and returns it's numeric value.

public  check({Array})

Parameters

Parameter	Type	Description
`$type`	`string`	If $type is a string, it is checked and if valid then it's numeric value is returned. If $type is

                    an integer it will be returned back if valid.  If either is not valid then false is returned. |

getType

public  getType({Array})

Parameters

Parameter	Type	Description
`$name`	`string`

getTypeName

public  getTypeName({Array})

Parameters

Parameter	Type	Description
`$type`	`mixed`

encode

public  encode({Array})

Parameters

Parameter	Type	Description
`$type`	`string`
`$payload`	`mixed`

decode

public  decode({Array})

Parameters

Parameter	Type	Description
`$packet`	`string`
`$payload`	`mixed`
`$time`	`int`

error

private  error({Array})

Parameters

Parameter	Type	Description
`$msg`	`string`

Generated by Hazaar API Doc Generator