Function

Soup-3.0 ▶ Soup ▶ websocket_client_prepare_handshake

  • Adds the necessary headers to msg to request a WebSocket handshake including supported WebSocket extensions.

    The message body and non-WebSocket-related headers are not modified.

    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

      a Soup.Message

    • origin: string | null

      the "Origin" header to set

    • protocols: string[] | null

      list of protocols to offer

    • supported_extensions: TypeClass[] | null

      list of supported extension types

    Returns void