Socket

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

Properties

bytesReceived

Total bytes received from the remote endpoint.

public int $bytesReceived

socketLastError

Last socket error code encountered.

public int $socketLastError

host

Remote server host name/address.

protected string $host = '127.0.0.1'

port

Remote server TCP port.

protected int $port = 13080

id

Client identifier used in handshake URL.

protected string $id

key

WebSocket handshake key.

protected string $key

public  $

connected

Internal connected flag.

protected bool $connected

protocol

Protocol encoder/decoder used for payload packets.

protected Protocol $protocol

frameBuffer

public string $frameBuffer

payloadBuffer

public string $payloadBuffer

closing

Indicates a close handshake is in progress.

protected bool $closing

headers

protected array $headers

Methods

__construct

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

Parameters

Parameter	Type	Description
$protocol	Protocol
$guid	string
$headers	array

__destruct

public __destruct(): void

configure

Applies runtime socket connection settings.

public configure(array $config): void

Parameters

Parameter	Type	Description
$config	array

getHost

Get the host of the Warlock server.

public getHost(): string

getPort

Get the port of the Warlock server.

public getPort(): int

connect

Connect to the Warlock server.

public connect(): bool

getLastSocketError

public getLastSocketError(bool $asString): string

Parameters

Parameter	Type	Description
$asString	bool

disconnect

public disconnect(): bool

connected

public connected(): bool

send

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

Parameters

Parameter	Type	Description
$command	PacketType
$payload	mixed

recv

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

Parameters

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

processFrame

protected processFrame(?string $frameBuffer): string

Parameters

Parameter	Type	Description
$frameBuffer	string

---

Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:25 +0000