php8.5
Home/ Manual/ event / eventbuffer/ EventBuffer::copyout

EventBuffer::copyout

PHP function Edit on GitHub ✎

(PECL event >= 1.2.6-beta)

Copies out specified number of bytes from the front of the buffer

Description

EventBuffer::copyout(string $data, int $max_bytes): int

Behaves just like EventBuffer::read, but does not drain any data from the buffer. I.e. it copies the first max_bytes bytes from the front of the buffer into data. If there are fewer than max_bytes bytes available, the function copies all the bytes there are.

Parameters

data

Output string.

max_bytes

The number of bytes to copy.

Return Values

Returns the number of bytes copied, or -1 on failure.

See Also

  • EventBuffer::read
  • EventBuffer::appendFrom

Source: reference/event/eventbuffer/copyout.xml · from the official PHP manual (php/doc-en)