Soup.SessionFeature¶

Implementations:: Soup.AuthManager, Soup.Cache, Soup.ContentDecoder, Soup.ContentSniffer, Soup.CookieJar, Soup.HSTSEnforcer, Soup.Logger, Soup.ProxyResolverDefault, Soup.Requester, Soup.WebsocketExtensionManager

Methods¶

	`add_feature` (type)
	`attach` (session)
	`detach` (session)
	`has_feature` (type)
	`remove_feature` (type)

Virtual Methods¶

	`do_add_feature` (type)
	`do_attach` (session)
	`do_detach` (session)
	`do_has_feature` (type)
	`do_remove_feature` (type)
	`do_request_queued` (session, msg)
	`do_request_started` (session, msg, socket)
	`do_request_unqueued` (session, msg)

Properties¶

None

Signals¶

None

Fields¶

None

Class Details¶

class Soup.SessionFeature¶

Bases:: GObject.GInterface
Structure:: Soup.SessionFeatureInterface

An object that implement some sort of optional feature for Soup.Session.

New in version 2.24.

add_feature(type)¶

Parameters:: type (GObject.GType) – the GObject.GType of a “sub-feature”
Returns:: True if self accepted type as a subfeature.
Return type:: bool

Adds a “sub-feature” of type type to the base feature self. This is used for features that can be extended with multiple different types. Eg, the authentication manager can be extended with subtypes of Soup.Auth.

New in version 2.34.

attach(session)¶

Parameters:: session (Soup.Session) –

detach(session)¶

Parameters:: session (Soup.Session) –

has_feature(type)¶

Parameters:: type (GObject.GType) – the GObject.GType of a “sub-feature”
Returns:: True if self has a subfeature of type type
Return type:: bool

Tests if self has a “sub-feature” of type type. See Soup.SessionFeature.add_feature().

New in version 2.34.

remove_feature(type)¶

Parameters:: type (GObject.GType) – the GObject.GType of a “sub-feature”
Returns:: True if type was removed from self
Return type:: bool

Removes the “sub-feature” of type type from the base feature self. See Soup.SessionFeature.add_feature().

New in version 2.34.

do_add_feature(type) virtual¶

Parameters:: type (GObject.GType) – the GObject.GType of a “sub-feature”
Returns:: True if feature accepted type as a subfeature.
Return type:: bool

Adds a “sub-feature” of type type to the base feature feature. This is used for features that can be extended with multiple different types. Eg, the authentication manager can be extended with subtypes of Soup.Auth.

New in version 2.34.

do_attach(session) virtual¶

Parameters:: session (Soup.Session) –

Perform setup when a feature is added to a session

do_detach(session) virtual¶

Parameters:: session (Soup.Session) –

Perform cleanup when a feature is removed from a session

do_has_feature(type) virtual¶

Parameters:: type (GObject.GType) – the GObject.GType of a “sub-feature”
Returns:: True if feature has a subfeature of type type
Return type:: bool

Tests if feature has a “sub-feature” of type type. See Soup.SessionFeature.add_feature().

New in version 2.34.

do_remove_feature(type) virtual¶

Parameters:: type (GObject.GType) – the GObject.GType of a “sub-feature”
Returns:: True if type was removed from feature
Return type:: bool

Removes the “sub-feature” of type type from the base feature feature. See Soup.SessionFeature.add_feature().

New in version 2.34.

do_request_queued(session, msg) virtual¶

Parameters:

session (Soup.Session) –
msg (Soup.Message) –

Proxies the session’s #SoupSession::request_queued signal

do_request_started(session, msg, socket) virtual¶

Parameters:

session (Soup.Session) –
msg (Soup.Message) –
socket (Soup.Socket) –

Proxies the session’s #SoupSession::request_started signal. Deprecated 2.50. Use Soup.Message ::starting instead.

do_request_unqueued(session, msg) virtual¶

Parameters:

session (Soup.Session) –
msg (Soup.Message) –

Proxies the session’s #SoupSession::request_unqueued signal