EventBuffer::read »

« EventBuffer::prependBuffer

EventBuffer::pullup

(PECL event >= 1.2.6-beta)

EventBuffer::pullup — Linearizes data within buffer and returns it's contents as a string

Description

public EventBuffer::pullup( int $size ): string

"Linearizes" the first size bytes of the buffer, copying or moving them as needed to ensure that they are all contiguous and occupying the same chunk of memory. If size is negative, the function linearizes the entire buffer.

Warning

Calling EventBuffer::pullup() with a large size can be quite slow, since it potentially needs to copy the entire buffer's contents.

Parameters

size: The number of bytes required to be contiguous within the buffer.

Return Values

If size is greater than the number of bytes in the buffer, the function returns null. Otherwise, EventBuffer::pullup() returns string.

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::read() - Read data from an evbuffer and drain the bytes read
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

Improve This Page

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

User Contributed Notes

There are no user contributed notes for this page.