EBackend.SubprocessFactory¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37), Gio.Initable (2)
Structs:: GObject.ObjectClass (5)

class	`construct_path` ()
	`call_backends_prepare_shutdown` ()
	`get_backends_list` ()
	`get_registry` ()
	`open_backend` (connection, uid, backend_factory_type_name, module_filename, proxy, cancellable)
	`ref_initable_backend` (uid, backend_factory_type_name, module_filename, cancellable)
	`set_backend_callbacks` (backend, proxy)

Virtual Methods¶

Inherited:: GObject.Object (7), Gio.Initable (1)

	`do_backend_closed` (backend)
	`do_backend_created` (backend)
	`do_open_data` (backend, connection, data, cancellable)

Properties¶

Name	Type	Flags	Short Description
`registry`	`EDataServer.SourceRegistry`	r	Data source registry

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class EBackend.SubprocessFactory(**kwargs)¶

Bases:: GObject.Object, Gio.Initable
Abstract:: No
Structure:: EBackend.SubprocessFactoryClass

Contains only private data that should be read and manipulated using the functions below.

New in version 3.16.

classmethod construct_path()¶

Returns:

a newly allocated string, representing the object path for the D-Bus interface.

This function is here for a lack of a better place

Return type:

str

Returns a new and unique object path for a D-Bus interface based in the data object path prefix of the subprocess_factory

New in version 3.16.

call_backends_prepare_shutdown()¶: Calls EBackend.Backend.prepare_shutdown() for the list of used backends.

New in version 3.16.

get_backends_list()¶

Returns:: A GLib.List that contains a list of used backends. The list should be freed by the caller using: g_list_free_full (backends, GObject.Object.unref).
Return type:: [EBackend.Backend]

Returns a list of used backends.

New in version 3.16.

get_registry()¶

Returns:: the EDataServer.SourceRegistry
Return type:: EDataServer.SourceRegistry

Returns the EDataServer.SourceRegistry owned by self.

New in version 3.16.

open_backend(connection, uid, backend_factory_type_name, module_filename, proxy, cancellable)¶

Parameters:

connection (Gio.DBusConnection) – a Gio.DBusConnection
uid (str) – UID of an EDataServer.Source to open
backend_factory_type_name (str) – the name of the backend factory type
module_filename (str) – the name (full-path) of the backend module to be loaded
proxy (Gio.DBusInterfaceSkeleton) – a Gio.DBusInterfaceSkeleton, used to communicate to the subprocess backend
cancellable (Gio.Cancellable or None) – a Gio.Cancellable

Raises:

GLib.Error

Returns:

a newly allocated string that represents the EBackend.Backend data D-Bus object path.

Return type:

str

Returns the EBackend.Backend data D-Bus object path

New in version 3.16.

ref_initable_backend(uid, backend_factory_type_name, module_filename, cancellable)¶

Parameters:

uid (str) – UID of an EDataServer.Source to open
backend_factory_type_name (str) – the name of the backend factory type
module_filename (str) – the name (full-path) of the backend module to be loaded
cancellable (Gio.Cancellable or None) – optional Gio.Cancellable object, or None

Raises:

GLib.Error

Returns:

an EBackend.Backend for source, or None

Return type:

EBackend.Backend or None

Returns either a newly-created or existing EBackend.Backend for EDataServer.Source. The returned EBackend.Backend is referenced for thread-safety and must be unreferenced with GObject.Object.unref() when finished with it.

If the newly-created backend implements the Gio.Initable interface, then Gio.Initable.init() is also called on it using cancellable and error.

The self retains a strong reference to backend.

If no suitable EBackend.BackendFactory exists, or if the EBackend.Backend fails to initialize, the function sets error and returns None.

New in version 3.16.

set_backend_callbacks(backend, proxy)¶

Parameters:

backend (EBackend.Backend) – an EBackend.Backend
proxy (Gio.DBusInterfaceSkeleton) – a Gio.DBusInterfaceSkeleton, used to communicate to the subprocess backend

Installs a toggle reference on the backend, that can receive a signal to shutdown once all client connections are closed.

New in version 3.16.

do_backend_closed(backend) virtual¶

Parameters:: backend (EBackend.Backend) –

do_backend_created(backend) virtual¶

Parameters:: backend (EBackend.Backend) –

do_open_data(backend, connection, data, cancellable) virtual¶

Parameters:

backend (EBackend.Backend) –
connection (Gio.DBusConnection) –
data (object or None) –
cancellable (Gio.Cancellable or None) –

Return type:

str

Property Details¶

EBackend.SubprocessFactory.props.registry¶

Name:: registry
Type:: EDataServer.SourceRegistry
Default Value:: None
Flags:: READABLE

Data source registry