Spec-Zone.ru › Dart 2

dart:io

Конструктор WebSocket.fromUpgradedSocket

WebSocket.fromUpgradedSocket(
  1. Socket socket,
  2. {String? protocol,
  3. bool? serverSide,
  4. CompressionOptions compression = CompressionOptions.compressionDefault}
)

Создаёт WebSocket из уже обновлённого сокета.

Инициализация рукопожатия WebSocket должна произойти до вызова этого метода. Клиент WebSocket может автоматически выполнить рукопожатие с помощью WebSocket.connect, а сервер — с помощью WebSocketTransformer.upgrade. Для ручного обновления HttpRequest можно вызвать HttpResponse.detachSocket.

protocol должен быть протоколом, согласованным при этом рукопожатии (если таковой имеется).

serverSide необходимо передавать явно. Если это false, WebSocket будет действовать как клиент и маскировать отправляемые сообщения. Если это true, он будет действовать как сервер и не будет маскировать свои сообщения.

Если compression указан, созданный WebSocket будет настроен для согласования со специфицированными CompressionOptions. Если не указан, WebSocket будет создан с использованием значения по умолчанию CompressionOptions.

Реализация

factory WebSocket.fromUpgradedSocket(Socket socket,
    {String? protocol,
    bool? serverSide,
    CompressionOptions compression = CompressionOptions.compressionDefault}) {
  if (serverSide == null) {
    throw ArgumentError("The serverSide argument must be passed "
        "explicitly to WebSocket.fromUpgradedSocket.");
  }
  return _WebSocketImpl._fromSocket(
      socket, protocol, compression, serverSide);
}

© 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/WebSocket.fromUpgradedSocket.html

Spec-Zone.ru

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