DiscordPHP Documentation

FrameDecoder
in package

FinalYes

Incremental, bounded little-endian IPC framing; JSON interpretation belongs to the client.

Tags
since
10.69.0

Table of Contents

Properties

$buffer  : string
$maxBufferBytes  : int
$maxFrameBytes  : int

Methods

__construct()  : mixed
append()  : void
clear()  : void
encode()  : string
next()  : array{int, string}|null

Properties

Methods

__construct()

public __construct([int $maxFrameBytes = 1048576 ][, int $maxBufferBytes = 2097168 ]) : mixed
Parameters
$maxFrameBytes : int = 1048576
$maxBufferBytes : int = 2097168

append()

public append(string $bytes) : void
Parameters
$bytes : string

encode()

public static encode(int $opcode, string $payload) : string
Parameters
$opcode : int
$payload : string
Return values
string

next()

public next() : array{int, string}|null
Return values
array{int, string}|null —

A complete opcode/payload pair, or null until more bytes arrive.

On this page

Search results