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。映射的键是头部字段，值是String或List。.

如果提供了headers，则WebSocket连接过程将控制一些头部。这些头部包括

  • 连接
  • 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);