Класс EventBufferEvent

    (PECL event >= 1.2.6-beta)

    Введение

    Представляет буферизированное событие Libevent.

    Обычно приложению необходимо произвести буферизацию некоторого количества данных в дополнение к тому, чтоб просто реагировать на события. Когда мы, к примеру, хотим записывать данные, обычный алгоритм выглядит так:

    1. Решаем, что нам надо записать данные в соединение; складываем данные в буфер

    2. Ожидаем, когда соединение станет доступным для записи

    3. Записываем столько данных, сколько можем

    4. Запоминаем, сколько данных записали и, если остались недозаписанные данные, ждём, когда соединение снова станет доступно для записи.

    Это шаблон буферизированного вводы/вывода настолько распространён, что Libevent предоставляет встроенный механизм для него. "Буферизированное событие" состоит из транспорта (например сокета), буфера чтения и буфера записи. В отличие от стандартных событий, которые используют функцию обратного вызова когда транспорт становится доступен для чтения или записи, буферизованное событие вызывает функцию обратного вызова тогда, когда прочитает или запишет достаточное количество данных.

    Обзор классов

    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
    }

    Свойства

    fd

    Числовой файловый дескриптор связанный с буферизированным сокетом. Обычно является связанным сокетом. Равен null, если отсутствует файловый дескриптор(сокет) связанный с буферизированным событием.

    priority

    Приоритет событий, используемых для реализации буферизованных событий.

    input

    Нижележащий объект входящего буфера ( EventBuffer )

    output

    Нижележащий объект исходящего буфера ( EventBuffer )

    Предопределённые константы

    EventBufferEvent::READING

    Событие произошло в момент операции чтения из bufferevent. Проверьте другие флаги для этого события.

    EventBufferEvent::WRITING

    Событие произошло в момент операции записи в bufferevent. Проверьте другие флаги для этого события.

    EventBufferEvent::EOF

    Получен признак конца файла для буферизированного события.

    EventBufferEvent::ERROR

    Произошла ошибка во время операции с bufferevent. Подробную информацию об ошибке можно получить с помощью методов EventUtil::getLastSocketErrno() и/или EventUtil::getLastSocketError() .

    EventBufferEvent::TIMEOUT

    EventBufferEvent::CONNECTED

    Запрошенное соединение с bufferevent установлено.

    EventBufferEvent::OPT_CLOSE_ON_FREE

    Закрыть нижележащий транспорт, когда объект буферизированного события уничтожен. Будет закрыт сокет, уничтожен буфер и т.д.

    EventBufferEvent::OPT_THREADSAFE

    Автоматически размещать блокировки для bufferevent, что позволяет безопасно использовать многопоточность.

    EventBufferEvent::OPT_DEFER_CALLBACKS

    Когда флаг установлен, bufferevent откладывает все свои функции обратного вызова. Смотрите » Быстрое, переносимое, неблокирующее сетевое программирование с Libevent и отложенными функциями обратного вызова (Deferred callbacks) .

    EventBufferEvent::OPT_UNLOCK_CALLBACKS

    По умолчанию, когда bufferevent настроен как потокобезопасный, для буферизированного события будут сохраняться блокировки при запуске любых пользовательских функций обратного вызова. Установка этого флага говорит Libevent убирать блокировки при вызове этих callback-функций.

    EventBufferEvent::SSL_OPEN

    Подтверждение SSL завершено

    EventBufferEvent::SSL_CONNECTING

    В текущий момент SSL участвует в установлении соединения как клиент

    EventBufferEvent::SSL_ACCEPTING

    В текущий момент SSL участвует в установлении соединения как сервер

    Содержание

    To Top