Function

Soup-3.0 ▶ Soup ▶ websocket_client_verify_handshake

  • Looks at the response status code and headers in msg and determines if they contain a valid WebSocket handshake response (given the handshake request in msg's request headers).

    If supported_extensions is non-null, extensions included in the response "Sec-WebSocket-Extensions" are verified too. Accepted extensions are returned in accepted_extensions parameter if non-null.

    This is a low-level function; if you use Session.websocket_connect_async to create a WebSocket connection, it will call this for you.

    Parameters

    • msg: Soup.Message

      Soup.Message containing both client and server sides of a WebSocket handshake

    • Optionalsupported_extensions: TypeClass[]

      list of supported extension types

    Returns [boolean, Soup.WebsocketExtension[]]

    true if msg contains a completed valid WebSocket handshake, false and an error if not.