|
3 | 3 | ``` |
4 | 4 | jppm add jphp-websocket-client |
5 | 5 | ``` |
6 | | -## Примеры |
| 6 | +## Пример |
7 | 7 | ```php |
8 | 8 | use php\net\websocket\WebSocket; |
| 9 | +use php\net\websocket\WebSocketFrame; |
| 10 | +use php\net\websocket\WebSocketException; |
9 | 11 |
|
10 | | -// Инициализация |
11 | | -$client = new WebSocket(); |
12 | | -$client->url = 'wss://example.org/'; |
13 | | -$client->addHeader('Authorization', 'Bearer abcdefgh0123456789'); |
14 | | - |
15 | | -// События |
16 | | -$client->on('open', function(int $code, string $message, array $headers){ |
17 | | - echo "Соединение установлено!\n"; |
| 12 | +$ws = new WebSocket; // Создаём WebSocket |
| 13 | +$ws->url = 'ws://127.0.0.1:8888/simple_server/'; // Задаём url |
| 14 | +$ws->connectionTimeout = 5000; // Задаём максимальное время подключения |
| 15 | +// Настраиваем прокси |
| 16 | +$ws->proxyHost = '159.183.31.220'; |
| 17 | +$ws->proxyPort = 3128; |
| 18 | +$ws->proxyPassword = 'sqrt322'; |
| 19 | +// Навешиваем обработчики для событий |
| 20 | +$ws->on('stateChanged', function(string $state){ |
| 21 | + echo "stateChanged: {$state}\n"; |
| 22 | +}); |
| 23 | +$ws->on('connected', function(array $headers)use($ws){ |
| 24 | + //var_dump($headers); |
| 25 | + echo "Successful connection\n"; |
| 26 | + $ws->sendText('hey'); |
| 27 | +}); |
| 28 | +$ws->on('textMessage', function(string $message)use($ws){ |
| 29 | + echo "Input message: {$message}\n"; |
| 30 | + if($message == 'bye'){ |
| 31 | + $ws->sendText('see you later :)'); |
| 32 | + } |
| 33 | +}); |
| 34 | +$ws->on('connectError', function(WebSocketException $e){ |
| 35 | + echo "Connection error: {$e->getMessage()}\n"; |
| 36 | +}); |
| 37 | +$ws->on('disconnected', function(WebSocketFrame $serverCloseFrame){ |
| 38 | + echo "WebSocket closed by reason: {$serverCloseFrame->closeReason}\n"; |
18 | 39 | }); |
19 | | -$client->on('message', function(string $message){ |
20 | | - echo "Получено сообщение: {$message}\n"; |
| 40 | +$ws->on('sendingHandshake', function($request, $headers){ |
| 41 | + echo "sendingHandshake({$request}):\n"; |
| 42 | + //var_dump($headers); |
21 | 43 | }); |
22 | | -$client->on('close', function(int $code, string $message, bool $remote){ |
23 | | - echo "Соединение закрыто({$code}-{$message})\n"; |
| 44 | +$ws->connectAsynchronously(); // Подключаемся |
| 45 | +``` |
| 46 | +## События |
| 47 | +### connected |
| 48 | +```php |
| 49 | +$ws->on("connected", function(array $headers){ |
| 50 | + // Вызывается после успешного подключения. |
24 | 51 | }); |
25 | | -$client->on('error', function(\Exception $e){ |
26 | | - echo "Ошибка - {$e->getMessage()}\n"; |
| 52 | +``` |
| 53 | +### connectError |
| 54 | +```php |
| 55 | +$ws->on("connectError", function(WebSocketException $cause){ |
| 56 | + // Вызывается после неудачного вызова connectAsynchronously. |
| 57 | +}); |
| 58 | +``` |
| 59 | +### stateChanged |
| 60 | +```php |
| 61 | +$ws->on("stateChanged", function(string $state){ |
| 62 | + // Вызывается при смене состояния WebSocket`а. Возможные значения: |
| 63 | + // CREATED, CONNECTING, OPEN, CLOSING, CLOSED |
| 64 | +}); |
| 65 | +``` |
| 66 | +### disconnected |
| 67 | +```php |
| 68 | +$ws->on("disconnected", function(WebSocketFrame $serverCloseFrame, WebSocketFrame $clientCloseFrame, bool $closedByServer){ |
| 69 | + // Вызывается после завершения подключения WebSocket`а. |
| 70 | +}); |
| 71 | +``` |
| 72 | +### frame |
| 73 | +```php |
| 74 | +$ws->on("frame", function(WebSocketFrame $frame){ |
| 75 | + // Вызывается при получении фрейма. |
| 76 | +}); |
| 77 | +``` |
| 78 | +### continuationFrame |
| 79 | +```php |
| 80 | +$ws->on("continuationFrame", function(WebSocketFrame $frame){ |
| 81 | + // Вызывается при получении "продолжительного" фрейма(fin=0). |
| 82 | +}); |
| 83 | +``` |
| 84 | +### textFrame |
| 85 | +```php |
| 86 | +$ws->on("textFrame", function(WebSocketFrame $frame){ |
| 87 | + // Вызывается при получении текстового фрейма. |
| 88 | +}); |
| 89 | +``` |
| 90 | +### textMessage |
| 91 | +```php |
| 92 | +$ws->on("textMessage", function(string $message){ |
| 93 | + // Вызывается при получении текстового сообщения. |
| 94 | +}); |
| 95 | +``` |
| 96 | +### binaryFrame |
| 97 | +```php |
| 98 | +$ws->on("binaryFrame", function(WebSocketFrame $frame){ |
| 99 | + // Вызывается при получении бинарного фрейма. |
| 100 | +}); |
| 101 | +``` |
| 102 | +### pingFrame |
| 103 | +```php |
| 104 | +$ws->on("pingFrame", function(WebSocketFrame $frame){ |
| 105 | + // Вызывается при получении "пинг" фрейма(для проверки подключения). |
| 106 | +}); |
| 107 | +``` |
| 108 | +### pongFrame |
| 109 | +```php |
| 110 | +$ws->on("pongFrame", function(string $message){ |
| 111 | + // Вызывается при получении текстового сообщения. |
| 112 | +}); |
| 113 | +``` |
| 114 | +### sendingFrame |
| 115 | +```php |
| 116 | +$ws->on("sendingFrame", function(WebSocketFrame $frame){ |
| 117 | + // Вызывается при отправлении фрейма. |
| 118 | +}); |
| 119 | +``` |
| 120 | +### frameSent |
| 121 | +```php |
| 122 | +$ws->on("frameSent", function(WebSocketFrame $frame){ |
| 123 | + // Вызывается после успешного отправления фрейма. |
| 124 | +}); |
| 125 | +``` |
| 126 | +### frameUnsent |
| 127 | +```php |
| 128 | +$ws->on("frameUnsent", function(WebSocketFrame $frame){ |
| 129 | + // Вызывается после ошибки при отправлении фрейма. |
| 130 | +}); |
| 131 | +``` |
| 132 | +### threadCreated |
| 133 | +```php |
| 134 | +$ws->on("threadCreated", function(string $threadType, php\lang\Thread $thread){ |
| 135 | + // Вызывается при создании нового потока. Возможные значения для threadType: |
| 136 | + // READING_THREAD, WRITING_THREAD, CONNECT_THREAD, FINISH_THREAD |
| 137 | +}); |
| 138 | +``` |
| 139 | +### threadStarted |
| 140 | +```php |
| 141 | +$ws->on("threadStarted", function(string $threadType, php\lang\Thread $thread){ |
| 142 | + // Вызывается при запуске созданного потока. |
| 143 | +}); |
| 144 | +``` |
| 145 | +### threadStopping |
| 146 | +```php |
| 147 | +$ws->on("threadStopping", function(string $threadType, php\lang\Thread $thread){ |
| 148 | + // Вызывается при остановке созданного потока. |
| 149 | +}); |
| 150 | +``` |
| 151 | +### error |
| 152 | +```php |
| 153 | +$ws->on("error", function(WebSocketException $error){ |
| 154 | + // Вызывается при ошибке. |
| 155 | +}); |
| 156 | +``` |
| 157 | +### frameError |
| 158 | +```php |
| 159 | +$ws->on("frameError", function(WebSocketException $error, WebSocketFrame $frame){ |
| 160 | + // Вызывается при ошибке чтения фрейма. |
| 161 | +}); |
| 162 | +``` |
| 163 | +### messageError |
| 164 | +```php |
| 165 | +$ws->on("messageError", function(WebSocketException $error, array $frames){ |
| 166 | + // Вызывается при ошибке построения сообщения. |
| 167 | +}); |
| 168 | +``` |
| 169 | +### sendError |
| 170 | +```php |
| 171 | +$ws->on("sendError", function(WebSocketException $error, WebSocketFrame $frame){ |
| 172 | + // Вызывается при ошибке отправки фрейма. |
| 173 | +}); |
| 174 | +``` |
| 175 | +### unexpectedError |
| 176 | +```php |
| 177 | +$ws->on("unexpectedError", function(WebSocketException $error){ |
| 178 | + // Вызывается при неожиданной ошибке. |
| 179 | +}); |
| 180 | +``` |
| 181 | +### sendingHandshake |
| 182 | +```php |
| 183 | +$ws->on("sendingHandshake", function(string $requestLine, array $headers){ |
| 184 | + // Вызывается перед установкой соединения. |
27 | 185 | }); |
28 | | -$client->connect(); |
29 | | -// $client->connectAsync(); |
30 | 186 | ``` |
31 | 187 |
|
32 | 188 | ## Дополнительно |
33 | 189 |
|
34 | 190 | [Расширение для DevelNext](https://github.com/jphp-group/jphp-websocket-client/releases/latest) |
35 | 191 |
|
| 192 | +[Оригинальная библиотека](https://github.com/TakahikoKawasaki/nv-websocket-client) |
| 193 | + |
36 | 194 | [Venity](https://vk.com/venity) |
37 | 195 |
|
38 | 196 | [DevelNext - extensions & manuals.](https://vk.com/dn_extension) |
0 commit comments