La classe EventBufferEvent

    (PECL event >= 1.2.6-beta)

    Introduction

    Représente un buffer d'événement Libevent.

    Habituellement, une application veut mettre en buffer des données en plus de juste répondre à des événements. Lorsque nous voulons écrire des données, par exemple, le mécanisme habituel ressemble à :

    1. On décide que l'on veut écrire des données dans une connexion ; placez ces données dans un buffer.

    2. On attend que la connexion devienne accessible en écriture

    3. On écrit autant de données que l'on peut

    4. On se souvient de la quantité écrite, et si on a encore plus de données à écrire, on attend que la connexion redevienne accessible en écriture.

    Ce mécanisme de mise en buffer I/O est suffisament commune pour que Libevent fournisse un mécanisme générique pour cela. Un buffer d'événement consiste en un transport sous-jacent (comme un socket), un buffer de lecture, et un buffer d'écriture. Au lieu d'un événement classique, qui fournit des fonctions de rappel lorsque le transport sous-jacent est prêt à être lu ou écrit, un buffer d'événement appelle ses fonctions de rappel fournis par l'utilisateur lorsqu'il a lu ou écrit suffisament de données.

    Synopsis de la classe

    finalclassEventBufferEvent {
    constintREADING = 1;
    constintWRITING = 2;
    constintEOF = 16;
    constintERROR = 32;
    constintTIMEOUT = 64;
    constintCONNECTED = 128;
    constintOPT_CLOSE_ON_FREE = 1;
    constintOPT_THREADSAFE = 2;
    constintOPT_DEFER_CALLBACKS = 4;
    constintOPT_UNLOCK_CALLBACKS = 8;
    constintSSL_OPEN = 0;
    constintSSL_CONNECTING = 1;
    constintSSL_ACCEPTING = 2;
    publicint$fd;
    publicint$priority;
    publicreadonlyEventBuffer$input;
    publicreadonlyEventBuffer$output;
    publicclose(): void
    publicconnect(string$addr): bool
    publicconnectHost(
        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
    )
    publicstaticcreatePair(EventBase$base, int$options = 0): array
    publicdisable(int$events): bool
    publicenable(int$events): bool
    publicfree(): void
    publicgetDnsErrorString(): string
    publicgetEnabled(): int
    publicgetInput(): EventBuffer
    publicgetOutput(): EventBuffer
    publicread(int$size): string
    publicreadBuffer(EventBuffer$buf): bool
    publicsetCallbacks(
        callable$readcb,
        callable$writecb,
        callable$eventcb,
        mixed$arg = ?
    ): void
    publicsetPriority(int$priority): bool
    publicsetTimeouts(float$timeout_read, float$timeout_write): bool
    publicsetWatermark(int$events, int$lowmark, int$highmark): void
    publicsslError(): string
    publicstaticsslFilter(
        EventBase$base,
        EventBufferEvent$underlying,
        EventSslContext$ctx,
        int$state,
        int$options = 0
    ): EventBufferEvent
    publicsslGetCipherInfo(): string
    publicsslGetCipherName(): string
    publicsslGetCipherVersion(): string
    publicsslGetProtocol(): string
    publicsslRenegotiate(): void
    publicstaticsslSocket(
        EventBase$base,
        mixed$socket,
        EventSslContext$ctx,
        int$state,
        int$options = ?
    ): EventBufferEvent
    publicwrite(string$data): bool
    publicwriteBuffer(EventBuffer$buf): bool
    }

    Propriétés

    fd

    Descripteur de fichier numérique associé avec le buffer d'événement. Normalement, représent un socket lié. Vaut null s'il n'y a aucun descripteur de fichier (socket) associé avec le buffer d'événement.

    priority

    La priorité de l'événement, utilisée pour implémenter le buffer d'événement.

    input

    Objet de buffer d'entrée sous-jacent (EventBuffer)

    output

    Objet de buffer de sortie sous-jacent (EventBuffer)

    Constantes pré-définies

    EventBufferEvent::READING

    Un événement survient pendant l'opération de lecture sur le bufferevent. Voir les autres drapeaux pour connaître le type d'événement.

    EventBufferEvent::WRITING

    Un événement survient pendant une opération d'écriture sur le bufferevent. Voir les autres drapeaux pour connaître le type d'événement.

    EventBufferEvent::EOF

    On récupère une indication de fin de fichier sur le buffer d'événement.

    EventBufferEvent::ERROR

    Une erreur survient pendant une opération bufferevent. Pour plus d'informations sur l'erreur, appelez la méthode EventUtil::getLastSocketErrno() et/ou EventUtil::getLastSocketError().

    EventBufferEvent::TIMEOUT

    EventBufferEvent::CONNECTED

    Termine une connexion demandée sur le bufferevent.

    EventBufferEvent::OPT_CLOSE_ON_FREE

    Lorsque le buffer d'événement est libéré, ferme le transport sous-jacent. Ceci va clôre le socket sous-jacent, libérer le buffer d'événement sous-jacent, etc.

    EventBufferEvent::OPT_THREADSAFE

    Alloue automatiquement des verrous pour le bufferevent, afin de rendre sécurisé l'utilisation de plusieurs threads.

    EventBufferEvent::OPT_DEFER_CALLBACKS

    Lorsque ce drapeau est défini, le bufferevent reporte toutes ses fonctions de rappel. Voir »  la documentation sur la programmation réseau rapide, portable, non bloquante avec Libevent, le report des fonctions de rappel.

    EventBufferEvent::OPT_UNLOCK_CALLBACKS

    Par défaut, lorsque le bufferevent est défini pour être sécurisé au niveau des threads, le verrou du buffer d'événement est maintenu, y compris si une fonction de rappel utilisateur est appelée. La définition de cette option permet à Libevent de libérer le verrou du buffer d'événement lorsque la fonction de rappel est appelée.

    EventBufferEvent::SSL_OPEN

    La négociation SSL se fait

    EventBufferEvent::SSL_CONNECTING

    SSL effectue actuellement la négociation comme client

    EventBufferEvent::SSL_ACCEPTING

    SSL effectue actuellement la négociation comme serveur

    Sommaire

    To Top