Soup.WebsocketExtension¶

Subclasses:	`Soup.WebsocketExtensionDeflate`

Methods¶

Inherited:	GObject.Object (37)
Structs:	GObject.ObjectClass (5)

	`configure` (connection_type, params)
	`get_request_params` ()
	`get_response_params` ()
	`process_incoming_message` (header, payload)
	`process_outgoing_message` (header, payload)

Virtual Methods¶

Inherited:	GObject.Object (7)

	`do_configure` (connection_type, params)
	`do_get_request_params` ()
	`do_get_response_params` ()
	`do_process_incoming_message` (header, payload)
	`do_process_outgoing_message` (header, payload)

Properties¶

None

Signals¶

Inherited:	GObject.Object (1)

Fields¶

Inherited:	GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Soup.WebsocketExtension(**kwargs)¶

Bases:	`GObject.Object`
Abstract:	Yes
Structure:	`Soup.WebsocketExtensionClass`

configure(connection_type, params)¶

Parameters:	connection_type (`Soup.WebsocketConnectionType`) – either `Soup.WebsocketConnectionType.CLIENT` or `Soup.WebsocketConnectionType.SERVER` params ({`object`: `object`} or `None`) – the parameters, or `None`
Raises:	`GLib.Error`
Returns:	`True` if extension could be configured with the given parameters, or `False` otherwise
Return type:	`bool`

Configures self with the given params

get_request_params()¶

Returns:	a new allocated string with the parameters
Return type:	`str` or `None`

Get the parameters strings to be included in the request header. If the extension doesn’t include any parameter in the request, this function returns None.

New in version 2.68.

get_response_params()¶

Returns:	a new allocated string with the parameters
Return type:	`str` or `None`

Get the parameters strings to be included in the response header. If the extension doesn’t include any parameter in the response, this function returns None.

New in version 2.68.

process_incoming_message(header, payload)¶

Parameters:

header (int) – the message header
payload (GLib.Bytes) – the payload data

Raises:

GLib.Error

Returns:

the message payload data, or None in case of error

header:	the message header

Return type:

(GLib.Bytes, header: int)

Process a message after it’s received. If the payload isn’t changed the given payload is just returned, otherwise GLib.Bytes.unref() is called on the given payload and a new GLib.Bytes is returned with the new data.

Extensions using reserved bits of the header will reset them in header.

New in version 2.68.

process_outgoing_message(header, payload)¶

Parameters:

header (int) – the message header
payload (GLib.Bytes) – the payload data

Raises:

GLib.Error

Returns:

the message payload data, or None in case of error

header:	the message header

Return type:

(GLib.Bytes, header: int)

Process a message before it’s sent. If the payload isn’t changed the given payload is just returned, otherwise GLib.Bytes.unref() is called on the given payload and a new GLib.Bytes is returned with the new data.

Extensions using reserved bits of the header will change them in header.

New in version 2.68.

do_configure(connection_type, params) virtual¶

Parameters:	connection_type (`Soup.WebsocketConnectionType`) – either `Soup.WebsocketConnectionType.CLIENT` or `Soup.WebsocketConnectionType.SERVER` params ({`object`: `object`} or `None`) – the parameters, or `None`
Returns:	`True` if extension could be configured with the given parameters, or `False` otherwise
Return type:	`bool`

Configures extension with the given params

do_get_request_params() virtual¶

Returns:	a new allocated string with the parameters
Return type:	`str` or `None`

Get the parameters strings to be included in the request header. If the extension doesn’t include any parameter in the request, this function returns None.

New in version 2.68.

do_get_response_params() virtual¶

Returns:	a new allocated string with the parameters
Return type:	`str` or `None`

Get the parameters strings to be included in the response header. If the extension doesn’t include any parameter in the response, this function returns None.

New in version 2.68.

do_process_incoming_message(header, payload) virtual¶

Parameters:

header (int) – the message header
payload (GLib.Bytes) – the payload data

Returns:

the message payload data, or None in case of error

header:	the message header

Return type:

(GLib.Bytes, header: int)

Process a message after it’s received. If the payload isn’t changed the given payload is just returned, otherwise GLib.Bytes.unref() is called on the given payload and a new GLib.Bytes is returned with the new data.

Extensions using reserved bits of the header will reset them in header.

New in version 2.68.

do_process_outgoing_message(header, payload) virtual¶

Parameters:

header (int) – the message header
payload (GLib.Bytes) – the payload data

Returns:

the message payload data, or None in case of error

header:	the message header

Return type:

(GLib.Bytes, header: int)

Process a message before it’s sent. If the payload isn’t changed the given payload is just returned, otherwise GLib.Bytes.unref() is called on the given payload and a new GLib.Bytes is returned with the new data.

Extensions using reserved bits of the header will change them in header.

New in version 2.68.