« EventBuffer::writeEventBufferEvent::close »PHP ManualEvent

Клас EventBufferEvent

(PECL event >= 1.2.6-beta)

Вступ

Представляє буферизовану подію Libevent.

Зазвичай додатку потрібно зробити буферизацію певної кількості даних на додаток до того, щоб легко реагувати на події. Коли ми, наприклад, хочемо записувати дані, звичайний алгоритм має такий вигляд:

  1. Вирішуємо, що нам треба записати дані у з'єднання; складаємо дані у буфер

  2. Очікуємо, коли з'єднання стане доступним для запису

  3. Записуємо стільки даних, скільки можемо

  4. Запам'ятовуємо, скільки даних записали і якщо залишилися недозаписані дані, чекаємо, коли з'єднання знову стане доступним для запису.

Це шаблон буферизованого вводу/виводу настільки поширений, що Libevent надає вбудований механізм для нього. Буферизована подія складається з транспорту (наприклад сокета), буфера читання та буфера запису. На відміну від стандартних подій, які використовують функцію зворотного виклику, коли транспорт стає доступним для читання або запису, буферизована подія викликає функцію зворотного виклику тоді, коли прочитає або запише достатню кількість даних.

Огляд класів


     
    
    
    
     
      final
      class EventBufferEvent
     
     {
    
    /* Константы */
    
     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;

    /* Свойства */
    public
     int
      $fd;

    public
     int
      $priority;

    public
     readonly
     EventBuffer
      $input;

    public
     readonly
     EventBuffer
      $output;

    /* Методы */
    
   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

   }

Властивості

fd

Числовий файловий дескриптор пов'язаний із буферизованим сокетом. Зазвичай є пов'язаним сокетом. Рівний **null**якщо відсутній файловий дескриптор (сокет) пов'язаний з буферизованим подією.

priority

Пріоритет подій, які використовуються для буферизованих подій.

input

Нижчележачий об'єкт вхідного буфера ( EventBuffer

output

Нижчележачий об'єкт вихідного буфера ( EventBuffer

Обумовлені константи

EventBufferEvent::READING

Подія сталася в момент операції читання з буферевенти. Перевірте інші прапори цієї події.

EventBufferEvent::WRITING

Подія сталася в момент операції запису в буферевенті. Перевірте інші прапори цієї події.

EventBufferEvent::EOF

Отримано ознаку кінця файлу для буферизованого події.

EventBufferEvent::ERROR

Відбулася помилка під час операції з буфером. Детальну інформацію про помилку можна отримати за допомогою методів 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 бере участь у встановленні з'єднання як сервер

Зміст