EventBuffer::read
PHP function
Edit on GitHub ✎
(PECL event >= 1.6.0)
Read data from an evbuffer and drain the bytes read
Description
EventBuffer::read(int $max_bytes): string
Read the first max_bytes from the buffer and drain the bytes read. If more max_bytes are requested than are available in the buffer, it only extracts as many bytes as available.
Parameters
max_bytesMaximum number of bytes to read from the buffer.
Return Values
Returns string read, or false on failure.
Changelog
| Version | Description |
|---|---|
| PECL event 1.6.0 | Renamed EventBuffer::read(the old method name) to EventBuffer::read. EventBuffer::read now takes only max_bytes argument; returns string instead of integer. |
See Also
EventBuffer::copyoutEventBuffer::drainEventBuffer::pullupEventBuffer::readLineEventBuffer::appendFrom