справочник_по_api:веб-сервисы:websocket

Вы находитесь здесь: Главная » справочник_по_api » веб-сервисы » websocket
Эта страница только для чтения. Вы можете посмотреть её исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== WebSocket ======

В Websocketкласс реализует RFC 6455 сочетаемый с сервер WebSocket с обработкой событий.

Пространство имен: \CLI

Расположение файла:lib/cli/ws.php


===== Constructor =====
<code>
$server = new \CLI\WS( $addr, resource $ctx = NULL, $wait = 60 );
</code>
Первый аргумент $addr указывает, где сервер будет прослушивать соединения. Необязательный аргумент $ctx принимает контекст для socket'а, а аргумент $wait определяет значение тайм-аута.

Примеры

 * Прослушивание на локальном устройстве без шифрования
<code php>
$server = new CLI\WS('tcp://127.0.0.1:9000');
</code>
 * Прослушивание всех IP-адресов с шифрованием
<code php>
$server = new CLI\WS(
    'ssl://0.0.0.0:9000',
    stream_context_create([
        'ssl'=>[
            'local_cert' => '/path/to/.pem',
            'verify_peer' => FALSE,
            'verify_peer_name' => FALSE,
            'allow_self_signed' => TRUE
        ]
    ])
);
);
</code>
===== Методы =====

==== agents ====

**Получите всех агентов с совпадающим URI.**
<code>
Agent[] agents ( string $uri = NULL )
</code>
Возвращенные агенты можно фильтровать с помощью необязательного аргумента $uri.

==== events ====

**Верните зарегистрированные обработчики событий.**
<code>
array events( )
</code>
==== on ====

**Привяжите функцию к событию.**
<code>
\CLI\WS on ( string $event, callable $func )
</code>
Привязывает hook $func к событию $event и ее. Существующие bind'ы для $event заменяются на $func.

В разделе «Обработчики событий» перечислены все события.

==== kill ====

**Правильно завершите работу сервера.**
<code>
void kill ( )
</code>
Процесс выключения вызывает событие stop и завершает процесс PHP.

==== **run** ====

**Запустите сервер и прослушайте соединения.**
<code>
void run ( )
</code>
Метод run() ни возвращает значение , ни завершается. Вместо этого приложение закрывается по запросу (с помощью метода kill() или сигнала ОС) или при возникновении ошибки.

===== Event Handlers =====

Websocket предоставляет несколько событий для настройки. Обработчики событий регистрируются функцией on(), например, в следующем примере регистрируется анонимная функция для события start.
<code php>
$server->on('start', function(){
    echo 'Server started';
});
</code>
==== start ====

**Hook start выполняется при запуске сервера.**
<code php>
callable start ( \CLI\WS $server )
</code>
Обработчик событий получает сервер в качестве аргумента.

==== error ====

**Hoo kerror выполняется , когда происходит ошибка.**
<code php>
callable error ( \CLI\WS $server )
</code>
Обработчик событий получает сервер в качестве аргумента.

==== stop ====

**Hook stop выполняется , когда сервер (включая процессы PHP) закрывается.**
<code php>
callable stop ( \CLI\WS $server )
</code>
Обработчик событий получает сервер в качестве аргумента.

==== connect ====
**Hook connect выполняется , когда клиент подключается к серверу.**
<code php>
callable connect ( \CLI\Agent $agent )
</code>
Обработчик событий получает в качестве аргумента агента нового клиента .

==== disconnect ====

**Hook disconnect выполняется , когда клиент отключается от сервера.**
<code php>
callable disconnect ( \CLI\Agent $agent )
</code>
Обработчик событий получает в качестве аргумента отключающийся агент клиента . Агент уничтожается, как только обработчик завершает работу.

==== idle ====

**Hook idle выполняется , когда клиент бездействует.**
<code php>
callable idle ( \CLI\Agent $agent )
</code>
Обработчик событий получает агент клиента в качестве аргумента.

==== receive ====

**Hook receive выполняется , когда данные приложения приходят от клиента.**
<code php>
callable receive ( \CLI\Agent $agent, $op, $data )
</code>
Обработчик событий вызывается только для binary and text frames (см. RFC 6455, раздел-11.8 ). Следовательно, обработчик событий получает коды операций $op = WS::Binary( 0x01) и $op = WS::Text( 0x02).

Обработчик событий получает агент клиента в качестве первого аргумента. Код операции $op- WS::Binary или WS::Text. $data содержит полезные данные для конкретного приложения от клиента.

==== send ====

**Hook send выполняется , когда данные приложения посылается клиенту.**
<code php>
callable send ( \CLI\Agent $agent, $op, $data )
</code>
Обработчик событий не вызывается для frame pong ( WS::Pong, 0x0a) и connection close( WS:Close, 0x08). Допустимые коды операций: WS::Binaryи WS::Text(см. RFC 6455, раздел-11.8 ).

Обработчик событий получает агент клиента в качестве первого аргумента. Код операции $op определяется пользователем (см. Раздел об Агенте ) и должен быть либо WS::Binary или WS::Text. $data содержит полезную нагрузку для конкретного приложения для клиента.

===== Агент =====

==== server ====

**Получите сервер агента.**
<code php>
\CLI\WS server ( )
</code>
==== ID ====

**Получите идентификатор socket'а агента.**
<code php>
string id ( )
</code>
==== socket ====

**Получите ресурс socket'а агента.**
<code php>
resource socket ( )
</code>
==== verb ====

**Получите HTTP-команду агента.**
<code php>
string verb ( )
</code>
==== uri ====

**Получите HTTP URI агента.**
<code php>
string uri ( )
</code>
==== headers ====

**Получите HTTP-заголовки агента.**
<code php>
string[] headers ( )
</code>
Вы посетили:
Поиск

Навигация

Руководство

API

Ядро

Базы данных

Date mappers

Шаблонизация

Веб-сервисы

Разное

Печать/экспорт

Инструменты
