EVENTBUFFER(3) 1 EVENTBUFFER(3)
The EventBuffer class
INTRODUCTION
EventBuffer represents Libevent's "evbuffer", an utility functionality for buffered I/O.
Event buffers are meant to be generally useful for doing the "buffer" part of buffered network I/O.
CLASS SYNOPSIS
EventBuffer
EventBuffer
Constants
o const integer$EventBuffer::EOL_ANY0
o const integer$EventBuffer::EOL_CRLF1
o const integer$EventBuffer::EOL_CRLF_STRICT2
o const integer$EventBuffer::EOL_LF3
o const integer$EventBuffer::PTR_SET0
o const integer$EventBuffer::PTR_ADD1
Properties
o publicreadonly int$length
o publicreadonly int$contiguous_space
Methods
o public bool EventBuffer::add (string $data)
o public bool EventBuffer::addBuffer (EventBuffer $buf)
o public int EventBuffer::appendFrom (EventBuffer $buf, int $len)
o public EventBuffer::__construct (void )
o public int EventBuffer::copyout (string &$data, int $max_bytes)
o public bool EventBuffer::drain (int $len)
o public void EventBuffer::enableLocking (void )
o public bool EventBuffer::expand (int $len)
o public bool EventBuffer::freeze (bool $at_front)
o public void EventBuffer::lock (void )
o public bool EventBuffer::prepend (string $data)
o public bool EventBuffer::prependBuffer (EventBuffer $buf)
o public string EventBuffer::pullup (int $size)
o public string EventBuffer::read (int $max_bytes)
o public int EventBuffer::read (mixed $fd, int $howmuch)
o public string EventBuffer::readLine (int $eol_style)
o public mixed EventBuffer::search (string $what, [int $start = -1], [int $end = -1])
o public mixed EventBuffer::searchEol EventBuffer::EOL_ANY ([int $start = -1], [int $eol_style])
o public string EventBuffer::substr (int $start, [int $length])
o public bool EventBuffer::unfreeze (bool $at_front)
o public bool EventBuffer::unlock (void )
o public int EventBuffer::write (mixed $fd, [int $howmuch])
PROPERTIES
o $length
- The number of bytes stored in an event buffer.
o $contiguous_space
- The number of bytes stored contiguously at the front of the buffer. The bytes in a buffer may be stored in multiple separate
chunks of memory; the property returns the number of bytes currently stored in the first chunk.
PREDEFINED CONSTANTS
o EventBuffer::EOL_ANY - The end of line is any sequence of any number of carriage return and linefeed characters. This format is
not very useful; it exists mainly for backward compatibility.
o EventBuffer::EOL_CRLF - The end of the line is an optional carriage return, followed by a linefeed. (In other words, it is either
a "
" or a "
" .) This format is useful in parsing text-based Internet protocols, since the standards generally prescribe a
"
" line-terminator, but nonconformant clients sometimes say just "
" .
o EventBuffer::EOL_CRLF_STRICT - The end of a line is a single carriage return, followed by a single linefeed. (This is also known
as "
" . The ASCII values are 0x0D 0x0A ).
o EventBuffer::EOL_LF - The end of a line is a single linefeed character. (This is also known as "
" . It is ASCII value is 0x0A .)
o EventBuffer::PTR_SET - Flag used as argument of EventBuffer::setPosition method. If this flag specified, the position pointer is
moved to an absolute position within the buffer.
o EventBuffer::PTR_ADD - The same as EventBuffer::PTR_SET , except this flag causes EventBuffer::setPosition method to move position
forward up to the specified number of bytes(instead of setting absolute position).
PHP Documentation Group EVENTBUFFER(3)