Function

Soup-3.0 ▶ Soup ▶ websocket_server_process_handshake

  • Examines the method and request headers in msg and (assuming msg contains a valid handshake request), fills in the handshake response.

    If expected_origin is non-null, then only requests containing a matching "Origin" header will be accepted. If protocols is non-null, then only requests containing a compatible "Sec-WebSocket-Protocols" header will be accepted. If supported_extensions is non-null, then only requests containing valid supported extensions in "Sec-WebSocket-Extensions" header will be accepted. The accepted extensions will be returned in accepted_extensions parameter if non-null.

    This is a low-level function; if you use Server.add_websocket_handler to handle accepting WebSocket connections, it will call this for you.

    Parameters

    • msg: Soup.ServerMessage

      Soup.ServerMessage containing the client side of a WebSocket handshake

    • Optionalexpected_origin: string

      expected Origin header

    • Optionalprotocols: string[]

      allowed WebSocket protocols.

    • Optionalsupported_extensions: TypeClass[]

      list of supported extension types

    Returns [boolean, Soup.WebsocketExtension[]]

    true if msg contained a valid WebSocket handshake request and was updated to contain a handshake response. false if not.