Spec-Zone.ru › Dart 2

dart:io

статический метод connect

Future<WebSocket> connect(
  1. String url,
  2. {Iterable<String>? protocols,
  3. Map<String, dynamic>? headers,
  4. CompressionOptions compression = CompressionOptions.compressionDefault,
  5. HttpClient? customClient}
)

Создаёт новое соединение WebSocket. URL, указанный в url, должен использовать схему ws или wss.

Аргумент protocols задаёт подпротоколы, с которыми клиент готов работать.

Аргумент headers задаёт дополнительные HTTP-заголовки для установки соединения. Обычно это заголовок Origin и, возможно, файлы cookie. Ключами карты являются поля заголовков, а значениями — строки или списки строк.

Если указан headers, ряд заголовков контролируется процессом установления соединения WebSocket. Это заголовки:

  • connection
  • sec-websocket-key
  • sec-websocket-protocol
  • sec-websocket-version
  • upgrade

Если любой из этих заголовков передан в карте headers, он будет проигнорирован.

Если url содержит данные пользователя, они будут переданы в виде базовой аутентификации при установлении соединения.

Реализация

static Future<WebSocket> connect(String url,
        {Iterable<String>? protocols,
        Map<String, dynamic>? headers,
        CompressionOptions compression =
            CompressionOptions.compressionDefault,
        HttpClient? customClient}) =>
    _WebSocketImpl.connect(url, protocols, headers,
        compression: compression, customClient: customClient);

© 2012 the Dart project authors
Licensed under the BSD 3-Clause "New" or "Revised" License.
https://api.dart.dev/stable/2.19.6/dart-io/WebSocket/connect.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API