La classe EventBuffer

(PECL event >= 1.5.0)

Introduction

La classe EventBuffer représente "evbuffer" de Libevent, un utilitaire pour les I/O bufferisés.

Les buffers d'événements sont généralement utiles pour réaliser la partie buffer d'un réseau I/O bufferisé.

Synopsis de la classe

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;

/* Propriétés */

public readonly int $length;

public readonly int $contiguous_space;

/* Méthodes */

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

}

Propriétés

length: Le nombre d'octets stockés dans un buffer d'événement.
contiguous_space: Le nombre d'octets stockés de façon contiguë au début du buffer. Les octets dans un buffer peuvent être stockés dans plusieurs parties séparées de la mémoire ; cette propriété retourne le nombre d'octets actuellement stockés dans la première partie.

Constantes pré-définies

EventBuffer::EOL_ANY: La fin de ligne est une séquence de nombres représentant un retour chariot et une nouvelle ligne. Ce format n'est pas très utile ; il existe encore seulement pour des raisons de compatibilité ascendante.
EventBuffer::EOL_CRLF: La fin de ligne est un retour chariot optionnel, suivi par une nouvelle ligne. (En d'autres termes, c'est soit "\r\n", soit "\n"). Ce format est utile pour analyser les protocoles Internet basés sur du texte ; le standard veut qu'on utilise "\r\n" mais quelques clients fournissent seulement "\n".
EventBuffer::EOL_CRLF_STRICT: La fin de ligne est un simple retour chariot, suivi par une simple nouvelle ligne (aussi connu comme "\r\n". Les valeurs ASCII sont 0x0D 0x0A).
EventBuffer::EOL_LF: La fin de ligne est un simple caractère de nouvelle ligne (aussi connu comme "\n". La valeur ASCII est 0x0A).
EventBuffer::PTR_SET: Drapeau utilisé comme argument de la méthode EventBuffer::setPosition(). Si ce drapeau est spécifié, la position du pointeur est déplacée à une position absolue du buffer.
EventBuffer::PTR_ADD: Identique à EventBuffer::PTR_SET, sauf que ce drapeau fait que la méthode EventBuffer::setPosition() se déplace à une position en arrière par rapport au numéro d'octets spécifié (au lieu de définir une position absolue).

Sommaire

EventBuffer::add — Ajoute des données à la fin du tampon d'événement
EventBuffer::addBuffer — Déplace toutes les données du tampon fourni dans l'instance courante EventBuffer
EventBuffer::appendFrom — Déplace le nombre d'octets fourni depuis un tampon source vers la fin du tampon courant
EventBuffer::__construct — Construit un objet EventBuffer
EventBuffer::copyout — Copie le nombre d'octets spécifié depuis le début du tampon
EventBuffer::drain — Supprime un nombre spécifié d'octets depuis le début du tampon sans copier les données
EventBuffer::enableLocking — Description
EventBuffer::expand — Réserve de l'espace dans le tampon
EventBuffer::freeze — Permet d'empêcher les appels qui tentent de modifier un tampon d'événements de réussir
EventBuffer::lock — Acquiert un verrou sur le buffer
EventBuffer::prepend — Ajoute des données au début du buffer
EventBuffer::prependBuffer — Déplace toutes les données depuis le buffer source vers le début du buffer courant
EventBuffer::pullup — Sérialise les données du buffer et retourne le contenu du buffer sous la forme d'une chaîne
EventBuffer::read — Lit les données d'un evbuffer, et vide les octets lus
EventBuffer::readFrom — Lit des données depuis un fichier et les place à la fin du tampon
EventBuffer::readLine — Extrait une ligne depuis le début du tampon
EventBuffer::search — Recherche dans le tampon une occurrence d'une chaîne
EventBuffer::searchEol — Cherche dans le tampon une occurrence de fin de ligne
EventBuffer::substr — Soustrait une portion des données du tampon
EventBuffer::unfreeze — Ré-active les appels qui permettent de modifier un buffer d'événements
EventBuffer::unlock — Libère un verrou acquis avec EventBuffer::lock
EventBuffer::write — Écrit le contenu du buffer dans un fichier ou dans un socket