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

EventBuffer::readLine

PHP function Edit on GitHub ✎

(PECL event >= 1.2.6-beta)

Extracts a line from the front of the buffer

Description

EventBuffer::readLine(int $eol_style): string

Extracts a line from the front of the buffer and returns it in a newly allocated string. If there is not a whole line to read, the function returns null. The line terminator is not included in the copied string.

Parameters

eol_style

One of EventBuffer:EOL_* constants.

Return Values

On success returns the line read from the buffer, otherwise null.

See Also

  • EventBuffer::copyout
  • EventBuffer::drain
  • EventBuffer::pullup
  • EventBuffer::read
  • EventBuffer::appendFrom

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