Client

About 2 min

Client

Properties

log

public Logger $log

address

public string $address

port

public int $port

id

public string $id

type

public string $type = 'client'

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 = array (
  'attempts' => 0,
  'last' => 0,
  'retry' => 5,
  'retries' => 3,
)

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(mixed $stream, ?array $options): void

Parameters

Parameter	Type	Description
`$stream`	`mixed`
`$options`	`array`

__destruct

public __destruct(): void

initiateHandshake

Initiates a WebSocket client handshake.

public initiateHandshake(string $request): void

Parameters

Parameter	Type	Description
`$request`	`string`

recv

public recv(string $buf): void

Parameters

Parameter	Type	Description
`$buf`	`string`

send

public send(string $command, mixed $payload): bool

Parameters

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

disconnect

Process a stream client disconnect.

public disconnect(): bool

commandUnsubscribe

public commandUnsubscribe(string $eventID): bool

Parameters

Parameter	Type	Description
`$eventID`	`string`

commandTrigger

public commandTrigger(string $eventID, mixed $data, bool $echoClient = true): bool

Parameters

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

sendEvent

public sendEvent(string $eventID, string $triggerID, mixed $data): bool

Parameters

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

ping

public ping(): bool

pong

public pong(): void

checkRequestURL

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

protected checkRequestURL(string $url, bool $): void

Parameters

Parameter	Type	Description
`$url`	`string`
`$`	`bool`

httpResponse

Generate an HTTP response message.

protected httpResponse(int $code, ?string $body, array $headers = []): string

Parameters

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

write

protected write(string $frame): bool

Parameters

Parameter	Type	Description
`$frame`	`string`

processFrame

Processes a client data frame.

protected processFrame(string $frameBuffer): mixed

Parameters

Parameter	Type	Description
`$frameBuffer`	`string`

processCommand

protected processCommand(string $command, mixed $payload): bool

Parameters

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

commandAuthorise

protected commandAuthorise(\stdClass $payload, bool $acknowledge = true): bool

Parameters

Parameter	Type	Description
`$payload`	`\stdClass`
`$acknowledge`	`bool`

commandStatus

protected commandStatus(?\stdClass $payload): bool

Parameters

Parameter	Type	Description
`$payload`	`\stdClass`

commandSubscribe

protected commandSubscribe(string $eventID, ?array $filter): bool

Parameters

Parameter	Type	Description
`$eventID`	`string`
`$filter`	`array`

commandLog

protected commandLog(\stdClass $payload): bool

Parameters

Parameter	Type	Description
`$payload`	`\stdClass`

initiateWebSocketsHandshake

Initiates a WebSocket client handshake.

private initiateWebSocketsHandshake(array $headers): bool

Parameters

Parameter	Type	Description
`$headers`	`array`

initiateRESTHandshake

Initiates a REST client handshake.

private initiateRESTHandshake(array $headers, string $body): bool

Parameters

Parameter	Type	Description
`$headers`	`array`
`$body`	`string`

Generated by Hazaar API Doc Generator