Pipe

Less than 1 minute

class Pipe implements \Hazaar\Warlock\Connection\Connection

Properties

Total number of bytes received from stdin.

public int $bytesReceived

public string $guid

Protocol encoder/decoder for packet payloads.

private Protocol $protocol

Incomplete receive buffer awaiting a line terminator.

private string $buffer

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

Parameter	Type	Description
`$protocol`	`Protocol`	packet protocol implementation
`$guid`	`string`	optional connection identifier

Pipe transport has no runtime configuration options.

public configure(array $config): void

Parameter	Type	Description
`$config`	`array`

Returns fixed host label for pipe transports.

public getHost(): string

Returns fixed port value for pipe transports.

public getPort(): int

Pipe transport is always considered connected.

public connect(): bool

Flushes stdout and marks pipe connection as closed.

public disconnect(): bool

Pipe transport is always considered connected while process is alive.

public connected(): bool

Encodes and writes a packet to stdout.

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

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

Reads and decodes one packet from stdin.

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

Extracts one newline-delimited packet from a buffered stream.

private processPacket(?string $buffer): string

Parameter	Type	Description
`$buffer`	`string`

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