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 и, возможно, куки. Ключи карты — это поля заголовка, а значения — либо String, либо List<string>.

Если указан 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.18.5/dart-io/WebSocket/connect.html

Spec-Zone.ru

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