Spec-Zone.ru › Dart 2

dart:io

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

Future<WebSocket> upgrade(
  1. HttpRequest request,
  2. {dynamic protocolSelector(
    1. List<String> protocols
    )?,
  3. CompressionOptions compression = CompressionOptions.compressionDefault}
)

Преобразует HttpRequest в соединение WebSocket. Если запрос не является допустимым запросом на обновление WebSocket, будет возвращён HTTP-ответ с кодом состояния 500. В противном случае возвращённый future завершится объектом WebSocket после завершения процесса обновления.

Если задан protocolSelector, для выбора используемого протокола будет вызван protocolSelector, если клиент предоставил какие-либо протоколы. protocolSelector должен возвращать либо String, либо Future, завершающийся значением String. Значение String должно присутствовать в списке протоколов.

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

Реализация

static Future<WebSocket> upgrade(HttpRequest request,
    {Function(List<String> protocols)? protocolSelector,
    CompressionOptions compression = CompressionOptions.compressionDefault}) {
  return _WebSocketTransformerImpl._upgrade(
      request, protocolSelector, compression);
}

© 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/WebSocketTransformer/upgrade.html

Spec-Zone.ru

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