La clase EventBufferEvent

(PECL event >= 1.2.6-beta)

Introducción

Representa un buffer de eventos Libevent.

Normalmente, una aplicación desea poner en buffer datos además de simplemente responder a eventos. Cuando se desea escribir datos, por ejemplo, el mecanismo habitual se asemeja a:

Se decide que se desea escribir datos en una conexión; coloque estos datos en un buffer.
Se espera a que la conexión se vuelva accesible en escritura.
Se escribe la mayor cantidad de datos posible.
Se recuerda la cantidad escrita, y si aún hay más datos para escribir, se espera a que la conexión vuelva a ser accesible en escritura.

Este mecanismo de bufferización de E/S es lo suficientemente común como para que Libevent proporcione un mecanismo genérico para ello. Un buffer de eventos consta de un transporte subyacente (como un socket), un buffer de lectura y un buffer de escritura. En lugar de un evento clásico, que proporciona funciones de retrollamada cuando el transporte subyacente está listo para ser leído o escrito, un buffer de eventos llama a sus funciones de retrollamada proporcionadas por el usuario cuando ha leído o escrito suficientes datos.

Sinopsis de la Clase

final class EventBufferEvent {

/* Constantes */

const int READING = 1;

const int WRITING = 2;

const int EOF = 16;

const int ERROR = 32;

const int TIMEOUT = 64;

const int CONNECTED = 128;

const int OPT_CLOSE_ON_FREE = 1;

const int OPT_THREADSAFE = 2;

const int OPT_DEFER_CALLBACKS = 4;

const int OPT_UNLOCK_CALLBACKS = 8;

const int SSL_OPEN = 0;

const int SSL_CONNECTING = 1;

const int SSL_ACCEPTING = 2;

/* Propiedades */

public int $fd;

public int $priority;

public readonly EventBuffer $input;

public readonly EventBuffer $output;

/* Métodos */

public close(): void

public connect( string $addr ): bool

public connectHost(
     EventDnsBase $dns_base ,
     string $hostname ,
     int $port ,
     int $family = EventUtil::AF_UNSPEC
): bool

public __construct(
     EventBase $base ,
     mixed $socket = null ,
     int $options = 0 ,
     callable $readcb = null ,
     callable $writecb = null ,
     callable $eventcb = null ,
    mixed $arg = null
)

public static createPair( EventBase $base , int $options = 0 ): array

public disable( int $events ): bool

public enable( int $events ): bool

public free(): void

public getDnsErrorString(): string

public getEnabled(): int

public getInput(): EventBuffer

public getOutput(): EventBuffer

public read( int $size ): string

public readBuffer( EventBuffer $buf ): bool

public setCallbacks(
     callable $readcb ,
     callable $writecb ,
     callable $eventcb ,
     mixed $arg = ?
): void

public setPriority( int $priority ): bool

public setTimeouts( float $timeout_read , float $timeout_write ): bool

public setWatermark( int $events , int $lowmark , int $highmark ): void

public sslError(): string

public static sslFilter(
     EventBase $base ,
     EventBufferEvent $underlying ,
     EventSslContext $ctx ,
     int $state ,
     int $options = 0
): EventBufferEvent

public sslGetCipherInfo(): string

public sslGetCipherName(): string

public sslGetCipherVersion(): string

public sslGetProtocol(): string

public sslRenegotiate(): void

public static sslSocket(
     EventBase $base ,
     mixed $socket ,
     EventSslContext $ctx ,
     int $state ,
     int $options = ?
): EventBufferEvent

public write( string $data ): bool

public writeBuffer( EventBuffer $buf ): bool

}

Propiedades

fd: Descriptor de fichero numérico asociado con el buffer de eventos. Normalmente, representa un socket enlazado. Vale null si no hay ningún descriptor de fichero (socket) asociado con el buffer de eventos.
priority: La prioridad del evento, utilizada para implementar el buffer de eventos.
input: Objeto de buffer de entrada subyacente (EventBuffer)
output: Objeto de buffer de salida subyacente (EventBuffer)

Constantes predefinidas

EventBufferEvent::READING: Un evento ocurre durante la operación de lectura en el bufferevent. Ver otros flags para conocer el tipo de evento.
EventBufferEvent::WRITING: Un evento ocurre durante una operación de escritura en el bufferevent. Ver otros flags para conocer el tipo de evento.
EventBufferEvent::EOF: Se recibe una indicación de fin de fichero en el buffer de eventos.
EventBufferEvent::ERROR: Un error ocurre durante una operación bufferevent. Para más información sobre el error, llame al método EventUtil::getLastSocketErrno() y/o EventUtil::getLastSocketError().
EventBufferEvent::TIMEOUT
EventBufferEvent::CONNECTED: Termina una conexión solicitada en el bufferevent.
EventBufferEvent::OPT_CLOSE_ON_FREE: Cuando el buffer de eventos es liberado, cierra el transporte subyacente. Esto cerrará el socket subyacente, liberará el buffer de eventos subyacente, etc.
EventBufferEvent::OPT_THREADSAFE: Asigna automáticamente bloqueos para el bufferevent, para hacer segura la utilización de múltiples threads.
EventBufferEvent::OPT_DEFER_CALLBACKS: Cuando este flag está definido, el bufferevent pospone todas sus funciones de retrollamada. Ver » la documentación sobre la programación de red rápida, portable, no bloqueante con Libevent, el posponer de las funciones de retrollamada.
EventBufferEvent::OPT_UNLOCK_CALLBACKS: Por omisión, cuando el bufferevent está definido para ser seguro al nivel de los threads, el bloqueo del buffer de eventos es mantenido, incluso si una función de retrollamada de usuario es llamada. La definición de esta opción permite a Libevent liberar el bloqueo del buffer de eventos cuando la función de retrollamada es llamada.
EventBufferEvent::SSL_OPEN: La negociación SSL se realiza.
EventBufferEvent::SSL_CONNECTING: SSL realiza actualmente la negociación como cliente.
EventBufferEvent::SSL_ACCEPTING: SSL realiza actualmente la negociación como servidor.

Tabla de contenidos

EventBufferEvent::close — Cierra el descriptor de fichero asociado con el buffer de eventos actual
EventBufferEvent::connect — Conecta el descriptor de fichero del búfer de eventos a la dirección proporcionada, o al socket UNIX
EventBufferEvent::connectHost — Conexión a un host
EventBufferEvent::__construct — Construye un objeto EventBufferEvent
EventBufferEvent::createPair — Crea dos eventos de buffer conectados entre sí
EventBufferEvent::disable — Desactiva los eventos de lectura, escritura o ambos en un evento de búfer
EventBufferEvent::enable — Activa los eventos de lectura, escritura, o ambos, en un evento de buffer
EventBufferEvent::free — Libera un evento de búfer
EventBufferEvent::getDnsErrorString — Devuelve un string que describe el último error DNS
EventBufferEvent::getEnabled — Devuelve una máscara de eventos actualmente activos en el búfer de eventos
EventBufferEvent::getInput — Devuelve el búfer de entrada asociado con el búfer de eventos actual
EventBufferEvent::getOutput — Devuelve el búfer de salida asociado con el búfer de evento actual
EventBufferEvent::read — Lee los datos del búfer
EventBufferEvent::readBuffer — Vacía el contenido entero del búfer de entrada y lo coloca en el búfer
EventBufferEvent::setCallbacks — Asigna las funciones de retrollamada para la lectura, la escritura y los estados de eventos
EventBufferEvent::setPriority — Asigna una prioridad para un búfer de eventos
EventBufferEvent::setTimeouts — Define el modo de lectura y escritura para el tiempo de espera máximo de un búfer de eventos
EventBufferEvent::setWatermark — Activa la lectura, y/o la escritura de las marcas de agua
EventBufferEvent::sslError — Devuelve el error OpenSSL más reciente reportado por el buffer de eventos
EventBufferEvent::sslFilter — Crea un nuevo búfer de evento SSL, cuyos datos serán enviados a través de otro búfer de evento
EventBufferEvent::sslGetCipherInfo — Devuelve una descripción textual de un cipher
EventBufferEvent::sslGetCipherName — Devuelve el nombre del cipher actual para la conexión SSL
EventBufferEvent::sslGetCipherVersion — Devuelve la versión del cipher utilizado para la conexión SSL actual
EventBufferEvent::sslGetProtocol — Devuelve el nombre del protocolo utilizado para la conexión SSL actual
EventBufferEvent::sslRenegotiate — Solicita al búfer de eventos iniciar una renegociación SSL
EventBufferEvent::sslSocket — Crea un nuevo buffer SSL cuyos datos serán enviados a través de un socket SSL
EventBufferEvent::write — Añade datos a un buffer de evento de salida
EventBufferEvent::writeBuffer — Añade el contenido entero de un buffer en un buffer de evento de salida