Client

Properties

log

public Logger $log

address

public string $address

port

public int $port

id

public string $id

type

public string $type

stream

public mixed $stream

closing

public bool $closing

frameBuffer

public string $frameBuffer

payloadBuffer

public string $payloadBuffer

applicationName

public string $applicationName

name

public string $name

username

public string $username

since

public int $since

lastContact

public int $lastContact

ping

public array $ping

offset

Any detected time offset. This doesn't need to be exact so we don't bother worrying about latency.

public int $offset

subscriptions

This is an array of eventID and stream pairs.

public array $subscriptions

tasks

If the client has any child task.

public  $tasks

start

protected int $start

Methods

__construct

public  __construct({Array})

Parameters

Parameter	Type	Description
$stream	mixed
$options	Map

__destruct

public  __destruct({Array})

initiateHandshake

Initiates a WebSocket client handshake.

public  initiateHandshake({Array})

Parameters

Parameter	Type	Description
$request	string

recv

public  recv({Array})

Parameters

Parameter	Type	Description
$buf	string

send

public  send({Array})

Parameters

Parameter	Type	Description
$command	string
$payload	mixed

disconnect

Process a stream client disconnect.

public  disconnect({Array})

commandUnsubscribe

public  commandUnsubscribe({Array})

Parameters

Parameter	Type	Description
$eventID	string

commandTrigger

public  commandTrigger({Array})

Parameters

Parameter	Type	Description
$eventID	string
$data	mixed
$echoClient	bool

sendEvent

public  sendEvent({Array})

Parameters

Parameter	Type	Description
$eventID	string
$triggerID	string
$data	mixed

ping

public  ping({Array})

pong

public  pong({Array})

checkRequestURL

Overridden method from WebSocket class to check the requested WebSocket URL is valid.

protected  checkRequestURL({Array})

Parameters

Parameter	Type	Description
$url	string
$	bool

httpResponse

Generate an HTTP response message.

protected  httpResponse({Array})

Parameters

Parameter	Type	Description
$code	int	HTTP response code
$body	string	The response body
$headers	array	Additional headers

write

protected  write({Array})

Parameters

Parameter	Type	Description
$frame	string

processFrame

Processes a client data frame.

protected  processFrame({Array})

Parameters

Parameter	Type	Description
$frameBuffer	string

processCommand

protected  processCommand({Array})

Parameters

Parameter	Type	Description
$command	string
$payload	mixed

commandAuthorise

protected  commandAuthorise({Array})

Parameters

Parameter	Type	Description
$payload	\stdClass
$acknowledge	bool

commandStatus

protected  commandStatus({Array})

Parameters

Parameter	Type	Description
$payload	\stdClass

commandSubscribe

protected  commandSubscribe({Array})

Parameters

Parameter	Type	Description
$eventID	string
$filter	array

commandLog

protected  commandLog({Array})

Parameters

Parameter	Type	Description
$payload	\stdClass

initiateWebSocketsHandshake

Initiates a WebSocket client handshake.

private  initiateWebSocketsHandshake({Array})

Parameters

Parameter	Type	Description
$headers	array

initiateRESTHandshake

Initiates a REST client handshake.

private  initiateRESTHandshake({Array})

Parameters

Parameter	Type	Description
$headers	array
$body	string

---

Generated by Hazaar API Doc Generator