Soup.CompressionDictionaryRequest

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	cancel ()
	set_dictionary (dictionary)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name	Type	Flags	Short Description
cancelled	bool	r
dictionary	GLib.Bytes	r

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Soup.CompressionDictionaryRequest(**kwargs)

Bases:

GObject.Object

Abstract:

No

Structure:

Soup.CompressionDictionaryRequestClass

Represents a pending request for a compression dictionary.

An instance is emitted with the [signal`Message`:py:func:::request-compression-dictionary<Soup.CompressionDictionaryRequest.signals.request_compression_dictionary>] signal. The handler should either call [method`CompressionDictionaryRequest`.set_dictionary] (synchronously or after ref-ing the object and completing asynchronously) or call [method`CompressionDictionaryRequest`.cancel], then return True. Return False to let other signal handlers run; if no handler returns True the request is treated as cancelled.

Added in version 3.8.

cancel()

Cancels a pending [signal`Message`:py:func:::request-compression-dictionary<Soup.CompressionDictionaryRequest.signals.request_compression_dictionary>] request, causing the response to fail.

This can be called synchronously inside the signal handler or asynchronously after ref-ing self and returning True from the handler.

Added in version 3.8.

set_dictionary(dictionary)

Parameters:

dictionary (GLib.Bytes) – the raw dictionary bytes

Provides the dictionary bytes for a pending [signal`Message`:py:func:::request-compression-dictionary<Soup.CompressionDictionaryRequest.signals.request_compression_dictionary>] request.

This can be called synchronously inside the signal handler or asynchronously after ref-ing self and returning True from the handler.

Added in version 3.8.

Property Details

Soup.CompressionDictionaryRequest.props.cancelled

Name:

cancelled

Type:

bool

Default Value:

False

Flags:

READABLE

Whether the request has been cancelled.

Set to True by [method`CompressionDictionaryRequest`.cancel].

Added in version 3.8.

Soup.CompressionDictionaryRequest.props.dictionary

Name:

dictionary

Type:

GLib.Bytes

Default Value:

None

Flags:

READABLE

The raw dictionary bytes provided to resolve the request, or None if none has been set yet.

Set with [method`CompressionDictionaryRequest`.set_dictionary].

Added in version 3.8.