La clase EventBuffer

(PECL event >= 1.5.0)

Introducción

La clase EventBuffer representa "evbuffer" de Libevent, una utilidad para las I/O bufferizadas.

Los buffers de eventos son generalmente útiles para realizar la parte buffer de una red I/O bufferizada.

Sinopsis de la Clase

class EventBuffer {

/* Constantes */

const int EOL_ANY = 0;

const int EOL_CRLF = 1;

const int EOL_CRLF_STRICT = 2;

const int EOL_LF = 3;

const int PTR_SET = 0;

const int PTR_ADD = 1;

/* Propiedades */

public readonly int $length;

public readonly int $contiguous_space;

/* Métodos */

public add( string $data ): bool

public addBuffer( EventBuffer $buf ): bool

public appendFrom( EventBuffer $buf , int $len ): int

public __construct()

public copyout( string &$data , int $max_bytes ): int

public drain( int $len ): bool

public enableLocking(): void

public expand( int $len ): bool

public freeze( bool $at_front ): bool

public lock(): void

public prepend( string $data ): bool

public prependBuffer( EventBuffer $buf ): bool

public pullup( int $size ): string

public read( int $max_bytes ): string

public read( mixed $fd , int $howmuch ): int

public readLine( int $eol_style ): string

public search( string $what , int $start = -1 , int $end = -1 ): mixed

public searchEol( int $start = -1 , int $eol_style = EventBuffer::EOL_ANY ): mixed

public substr( int $start , int $length = ?): string

public unfreeze( bool $at_front ): bool

public unlock(): bool

public write( mixed $fd , int $howmuch = ?): int

}

Propiedades

length: El número de bytes almacenados en un buffer de eventos.
contiguous_space: El número de bytes almacenados de manera contigua al inicio del buffer. Los bytes en un buffer pueden estar almacenados en varias partes separadas de la memoria; esta propiedad devuelve el número de bytes actualmente almacenados en la primera parte.

Constantes predefinidas

EventBuffer::EOL_ANY: El fin de línea es una secuencia de números que representan un retorno de carro y una nueva línea. Este formato no es muy útil; existe solo por razones de compatibilidad ascendente.
EventBuffer::EOL_CRLF: El fin de línea es un retorno de carro opcional, seguido de una nueva línea. (En otras palabras, es "\r\n" o "\n"). Este formato es útil para analizar los protocolos de Internet basados en texto; el estándar requiere "\r\n" pero algunos clientes proporcionan solo "\n".
EventBuffer::EOL_CRLF_STRICT: El fin de línea es un simple retorno de carro, seguido de una simple nueva línea (también conocido como "\r\n". Los valores ASCII son 0x0D 0x0A).
EventBuffer::EOL_LF: El fin de línea es un simple carácter de nueva línea (también conocido como "\n". El valor ASCII es 0x0A).
EventBuffer::PTR_SET: Flag utilizado como argumento del método EventBuffer::setPosition(). Si este flag es especificado, la posición del puntero es movida a una posición absoluta del buffer.
EventBuffer::PTR_ADD: Idéntico a EventBuffer::PTR_SET, excepto que este flag hace que el método EventBuffer::setPosition() se mueva a una posición hacia atrás en relación con el número de bytes especificado (en lugar de definir una posición absoluta).

Tabla de contenidos

EventBuffer::add — Añade datos al final de un buffer de eventos
EventBuffer::addBuffer — Desplaza todos los datos del búfer proporcionado al EventBuffer actual
EventBuffer::appendFrom — Mueve el número de bytes especificados desde un buffer fuente, al final del buffer actual
EventBuffer::__construct — Construye el objeto EventBuffer
EventBuffer::copyout — Copia el número de bytes especificado desde el inicio del búfer
EventBuffer::drain — Elimina un número especificado de bytes desde el inicio del búfer sin copiar los datos
EventBuffer::enableLocking — Descripción
EventBuffer::expand — Reserva espacio en el buffer
EventBuffer::freeze — Evita que las llamadas puedan modificar un buffer de eventos
EventBuffer::lock — Bloquea un buffer
EventBuffer::prepend — Añade datos al principio del buffer
EventBuffer::prependBuffer — Desplaza todos los datos desde el buffer fuente hacia el inicio del buffer actual
EventBuffer::pullup — Serializa los datos del buffer y devuelve el contenido del buffer en forma de string
EventBuffer::read — Lee los datos de un evbuffer y vacía los bytes leídos
EventBuffer::readFrom — Lee datos desde un fichero y los coloca al final del búfer
EventBuffer::readLine — Extrae una línea desde el inicio del búfer
EventBuffer::search — Busca en el búfer una ocurrencia de un string
EventBuffer::searchEol — Busca en el búfer una ocurrencia de fin de línea
EventBuffer::substr — Sustrae una porción de los datos del búfer
EventBuffer::unfreeze — Re-activa las llamadas que permiten modificar un buffer de eventos
EventBuffer::unlock — Libera un bloqueo adquirido con EventBuffer::lock
EventBuffer::write — Escribe el contenido del buffer en un fichero o en un socket