|
| 1 | +# WebSocket |
| 2 | + |
| 3 | +- **class** `WebSocket` (`php\net\websocket\WebSocket`) |
| 4 | +- **source** `php/net/websocket/WebSocket.php` |
| 5 | + |
| 6 | +--- |
| 7 | + |
| 8 | +#### Properties |
| 9 | + |
| 10 | +- `->`[`url`](#prop-url) : `string` |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +#### Methods |
| 15 | + |
| 16 | +- `->`[`__construct()`](#method-__construct) |
| 17 | +- `->`[`reconnect()`](#method-reconnect) |
| 18 | +- `->`[`reconnectAsync()`](#method-reconnectasync) |
| 19 | +- `->`[`connect()`](#method-connect) |
| 20 | +- `->`[`connectAsync()`](#method-connectasync) |
| 21 | +- `->`[`close()`](#method-close) |
| 22 | +- `->`[`off()`](#method-off) |
| 23 | +- `->`[`on()`](#method-on) |
| 24 | +- `->`[`send()`](#method-send) |
| 25 | +- `->`[`sendTextFrame()`](#method-sendtextframe) |
| 26 | +- `->`[`addHeader()`](#method-addheader) |
| 27 | +- `->`[`removeHeader()`](#method-removeheader) |
| 28 | +- `->`[`clearHeaders()`](#method-clearheaders) |
| 29 | +- `->`[`addHeaders()`](#method-addheaders) |
| 30 | + |
| 31 | +--- |
| 32 | +# Methods |
| 33 | + |
| 34 | +<a name="method-__construct"></a> |
| 35 | + |
| 36 | +### __construct() |
| 37 | +```php |
| 38 | +__construct(): void |
| 39 | +``` |
| 40 | + |
| 41 | +--- |
| 42 | + |
| 43 | +<a name="method-reconnect"></a> |
| 44 | + |
| 45 | +### reconnect() |
| 46 | +```php |
| 47 | +reconnect(): void |
| 48 | +``` |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +<a name="method-reconnectasync"></a> |
| 53 | + |
| 54 | +### reconnectAsync() |
| 55 | +```php |
| 56 | +reconnectAsync(): void |
| 57 | +``` |
| 58 | + |
| 59 | +--- |
| 60 | + |
| 61 | +<a name="method-connect"></a> |
| 62 | + |
| 63 | +### connect() |
| 64 | +```php |
| 65 | +connect(): void |
| 66 | +``` |
| 67 | + |
| 68 | +--- |
| 69 | + |
| 70 | +<a name="method-connectasync"></a> |
| 71 | + |
| 72 | +### connectAsync() |
| 73 | +```php |
| 74 | +connectAsync(): void |
| 75 | +``` |
| 76 | + |
| 77 | +--- |
| 78 | + |
| 79 | +<a name="method-close"></a> |
| 80 | + |
| 81 | +### close() |
| 82 | +```php |
| 83 | +close(int $code, string $status): void |
| 84 | +``` |
| 85 | + |
| 86 | +--- |
| 87 | + |
| 88 | +<a name="method-off"></a> |
| 89 | + |
| 90 | +### off() |
| 91 | +```php |
| 92 | +off(string $event, [ string $group): void |
| 93 | +``` |
| 94 | + |
| 95 | +--- |
| 96 | + |
| 97 | +<a name="method-on"></a> |
| 98 | + |
| 99 | +### on() |
| 100 | +```php |
| 101 | +on(string $event, callable $arg1, [ string $group): void |
| 102 | +``` |
| 103 | + |
| 104 | +--- |
| 105 | + |
| 106 | +<a name="method-send"></a> |
| 107 | + |
| 108 | +### send() |
| 109 | +```php |
| 110 | +send(mixed $text): void |
| 111 | +``` |
| 112 | + |
| 113 | +--- |
| 114 | + |
| 115 | +<a name="method-sendtextframe"></a> |
| 116 | + |
| 117 | +### sendTextFrame() |
| 118 | +```php |
| 119 | +sendTextFrame(string $text, boolean $isFinal): void |
| 120 | +``` |
| 121 | + |
| 122 | +--- |
| 123 | + |
| 124 | +<a name="method-addheader"></a> |
| 125 | + |
| 126 | +### addHeader() |
| 127 | +```php |
| 128 | +addHeader(string $key, string $value): void |
| 129 | +``` |
| 130 | + |
| 131 | +--- |
| 132 | + |
| 133 | +<a name="method-removeheader"></a> |
| 134 | + |
| 135 | +### removeHeader() |
| 136 | +```php |
| 137 | +removeHeader(string $key): void |
| 138 | +``` |
| 139 | + |
| 140 | +--- |
| 141 | + |
| 142 | +<a name="method-clearheaders"></a> |
| 143 | + |
| 144 | +### clearHeaders() |
| 145 | +```php |
| 146 | +clearHeaders(): void |
| 147 | +``` |
| 148 | + |
| 149 | +--- |
| 150 | + |
| 151 | +<a name="method-addheaders"></a> |
| 152 | + |
| 153 | +### addHeaders() |
| 154 | +```php |
| 155 | +addHeaders(array $args): void |
| 156 | +``` |
0 commit comments