Socket

class Socket extends \Hazaar\Warlock\Protocol\WebSockets implements \Hazaar\Warlock\Interface\Connection

Extends: Hazaar\Warlock\Protocol\WebSockets

Implements: Hazaar\Warlock\Interface\Connection

Properties

bytesReceived

Total bytes received from the remote endpoint.

public int $bytesReceived

Type: int

socketLastError

Last socket error code encountered.

public int $socketLastError

Type: int

host

Remote server host name/address.

protected string $host = '127.0.0.1'

Type: string

port

Remote server TCP port.

protected int $port = 13080

Type: int

id

Client identifier used in handshake URL.

protected string $id

Type: string

key

WebSocket handshake key.

protected string $key

Type: string

socket

Underlying PHP socket resource.

protected false|\Socket $socket

Type: false|Socket

connected

Internal connected flag.

protected bool $connected

Type: bool

protocol

Protocol encoder/decoder used for payload packets.

protected Protocol $protocol

Type: Hazaar\Warlock\Protocol

frameBuffer

public string $frameBuffer

Type: string

payloadBuffer

public string $payloadBuffer

Type: string

closing

Indicates a close handshake is in progress.

protected bool $closing

Type: bool

headers

protected array $headers

Type: array

Methods

__construct

public __construct(Protocol $protocol, ?string $guid, array $headers): void

Parameters

Parameter	Type	Description
$protocol	Hazaar\Warlock\Protocol
$guid	string
$headers	array

__destruct

public __destruct(): void

configure

Applies runtime socket connection settings.

public configure(array $config): void

Returns: void

The array $config signature is dictated by the Connection interface; internally it is normalised into a typed Options instance.

Parameters

Parameter	Type	Description
$config	array

addHeaders

Add custom headers to the WebSocket handshake request.

public addHeaders(array $headers): void

Returns: void

Parameters

Parameter	Type	Description
$headers	array	an associative array of header names and values to add to the handshake request

getHost

Get the host of the Warlock server.

public getHost(): string

Returns: string

getPort

Get the port of the Warlock server.

public getPort(): int

Returns: int

connect

Connect to the Warlock server.

public connect(): bool

Returns: bool

getLastSocketError

public getLastSocketError(bool $asString): string

Returns: string

Parameters

Parameter	Type	Description
$asString	bool

disconnect

public disconnect(): bool

Returns: bool

connected

public connected(): bool

Returns: bool

send

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

Returns: bool

Parameters

Parameter	Type	Description
$command	Hazaar\Warlock\Enum\PacketType
$payload	mixed

recv

public recv(mixed $payload, int $tvSec = 3, int $tvUsec): bool|PacketType|null

Returns: bool|Hazaar\Warlock\Enum\PacketType|null

Parameters

Parameter	Type	Description
$payload	mixed
$tvSec	int
$tvUsec	int

processFrame

protected processFrame(?string $frameBuffer): bool|string

Returns: bool|string

Parameters

Parameter	Type	Description
$frameBuffer	string

---

Generated by Hazaar API Doc Generator on Fri, 04 Sep 2026 23:32:17 +0000