EventBuffer::read
(PECL event >= 1.6.0)
EventBuffer::read — Read data from an evbuffer and drain the bytes read
Description
public
string
EventBuffer::read
(
int
$max_bytes
)
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_bytes -
Maxmimum number of bytes to read from the buffer.
Return Values
Returns string read, or FALSE on failure.
Changelog
| Version | Description |
|---|---|
| 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::copyout() - Copies out specified number of bytes from the front of the buffer
- EventBuffer::drain() - Removes specified number of bytes from the front of the buffer without copying it anywhere
- EventBuffer::pullup() - Linearizes data within buffer and returns it's contents as a string
- EventBuffer::readLine() - Extracts a line from the front of the buffer
- EventBuffer::appendFrom() - Moves the specified number of bytes from a source buffer to the end of the current buffer
- Функция EventBuffer::add() - Append data to the end of an event buffer
- Функция EventBuffer::addBuffer() - Move all data from a buffer provided to the current instance of EventBuffer
- EventBuffer::appendFrom
- Функция EventBuffer::__construct() - Constructs EventBuffer object
- Функция EventBuffer::copyout() - Copies out specified number of bytes from the front of the buffer
- EventBuffer::drain
- Функция EventBuffer::enableLocking() - Описание
- Функция EventBuffer::expand() - Reserves space in buffer
- Функция EventBuffer::freeze() - Prevent calls that modify an event buffer from succeeding
- Функция EventBuffer::lock() - Acquires a lock on buffer
- Функция EventBuffer::prepend() - Prepend data to the front of the buffer
- Функция EventBuffer::prependBuffer() - Moves all data from source buffer to the front of current buffer
- EventBuffer::pullup
- Функция EventBuffer::read() - Read data from an evbuffer and drain the bytes read
- Функция EventBuffer::readFrom() - Read data from a file onto the end of the buffer
- Функция EventBuffer::readLine() - Extracts a line from the front of the buffer
- Функция EventBuffer::search() - Scans the buffer for an occurrence of a string
- Функция EventBuffer::searchEol() - Scans the buffer for an occurrence of an end of line
- Функция EventBuffer::substr() - Substracts a portion of the buffer data
- Функция EventBuffer::unfreeze() - Re-enable calls that modify an event buffer
- Функция EventBuffer::unlock() - Releases lock acquired by EventBuffer::lock
- Функция EventBuffer::write() - Write contents of the buffer to a file or socket
Коментарии
This function is actually called readFrom(int fd, int max_bytes)