DBusObjectManagerClient

Object Hierarchy:

Description:

[ CCode ( type_id = "g_dbus_object_manager_client_get_type ()" ) ]
[ Version ( since = "2.30" ) ]
public class DBusObjectManagerClient : Object, AsyncInitable, DBusObjectManager, Initable

`GDBusObjectManagerClient` is used to create, monitor and delete object proxies for remote objects exported by a [class@Gio.

DBusObjectManagerServer] (or any code implementing the org.freedesktop.DBus.ObjectManager interface).

Once an instance of this type has been created, you can connect to the [signal@Gio.DBusObjectManager:GDBusObjectManagerClient:object-added] and [signal@Gio.DBusObjectManager:GDBusObjectManagerClient:object-removed signals] and inspect the [class@Gio.DBusObjectProxy] objects returned by [method@Gio.DBusObjectManager.get_objects].

If the name for a `GDBusObjectManagerClient` is not owned by anyone at object construction time, the default behavior is to request the message bus to launch an owner for the name. This behavior can be disabled using the `G_DBUS_OBJECT_MANAGER_CLIENT_FLAGS_DO_NOT_AUTO_START` flag. It’s also worth noting that this only works if the name of interest is activatable in the first place. E.g. in some cases it is not possible to launch an owner for the requested name. In this case, `GDBusObjectManagerClient` object construction still succeeds but there will be no object proxies (e.g. [method@Gio.DBusObjectManager.get_objects] returns the empty list) and the [property@Gio.DBusObjectManagerClient:name-owner ] property is `NULL`.

The owner of the requested name can come and go (for example consider a system service being restarted) – `GDBusObjectManagerClient` handles this case too; simply connect to the [signal@GObject.Object:GDBusObjectManagerClient:notify] signal to watch for changes on the [ property@Gio.DBusObjectManagerClient:name-owner] property. When the name owner vanishes, the behavior is that [ property@Gio.DBusObjectManagerClient:name-owner] is set to `NULL` (this includes emission of the [signal@GObject.Object:GDBusObjectManagerClient:notify] signal) and then [signal@Gio.DBusObjectManager:GDBusObjectManagerClient:object-removed] signals are synthesized for all currently existing object proxies. Since [property@Gio.DBusObjectManagerClient:name-owner] is `NULL` when this happens, you can use this information to disambiguate a synthesized signal from a genuine signal caused by object removal on the remote [ iface@Gio.DBusObjectManager]. Similarly, when a new name owner appears, [signal@Gio.DBusObjectManager:GDBusObjectManagerClient:object-added] signals are synthesized while [property@Gio.DBusObjectManagerClient:name-owner] is still `NULL`. Only when all object proxies have been added, the [property@Gio.DBusObjectManagerClient:name-owner] is set to the new name owner (this includes emission of the [signal@GObject.Object:GDBusObjectManagerClient:notify] signal). Furthermore, you are guaranteed that [ property@Gio.DBusObjectManagerClient:name-owner] will alternate between a name owner (e.g. `:1.42`) and `NULL` even in the case where the name of interest is atomically replaced

Ultimately, `GDBusObjectManagerClient` is used to obtain [class@Gio.DBusProxy] instances. All signals (including the `org.freedesktop.DBus.Properties:GDBusObjectManagerClient:PropertiesChanged` signal) delivered to [class@Gio.DBusProxy] instances are guaranteed to originate from the name owner. This guarantee along with the behavior described above, means that certain race conditions including the “half the proxy is from the old owner and the other half is from the new owner” problem cannot happen.

To avoid having the application connect to signals on the returned [class@Gio.DBusObjectProxy] and [class@Gio.DBusProxy] objects, the [ signal@Gio.DBusObject:GDBusObjectManagerClient:interface-added], [signal@Gio.DBusObject:GDBusObjectManagerClient:interface-removed], [signal@Gio.DBusProxy:GDBusObjectManagerClient:g-properties-changed] and [ signal@Gio.DBusProxy:GDBusObjectManagerClient:g-signal] signals are also emitted on the `GDBusObjectManagerClient` instance managing these objects. The signals emitted are [signal@Gio.DBusObjectManager:GDBusObjectManagerClient:interface-added], [ signal@Gio.DBusObjectManager:GDBusObjectManagerClient:interface-removed], [signal@Gio.DBusObjectManagerClient:GDBusObjectManagerClient:interface-proxy-properties-changed] and [signal@Gio.DBusObjectManagerClient:GDBusObjectManagerClient:interface-proxy-signal].

Note that all callbacks and signals are emitted in the thread-default main context (see [method@GLib.MainContext.push_thread_default]) that the `GDBusObjectManagerClient` object was constructed in. Additionally, the [class@Gio.DBusObjectProxy] and [class@Gio.DBusProxy] objects originating from the `GDBusObjectManagerClient` object will be created in the same context and, consequently, will deliver signals in the same main loop.

Namespace: GLib

Package: gio-2.0

Content:

Properties:

public BusType bus_type { construct; }
If this property is not g_bus_type_none, then connection must be null and will be set to the DBusConnection obtained by calling @get with the value of this property.
public DBusConnection connection { get; construct; }
The DBusConnection to use.
public DBusObjectManagerClientFlags flags { get; construct; }
Flags from the DBusObjectManagerClientFlags enumeration.
public void* get_proxy_type_destroy_notify { get; construct; }
A DestroyNotify for the pointer user_data in get_proxy_type_user_data.
public void* get_proxy_type_func { get; construct; }
The DBusProxyTypeFunc to use when determining what Type to use for interface proxies or null.
public void* get_proxy_type_user_data { get; construct; }
The pointer user_data to pass to get_proxy_type_func.
public string name { get; construct; }
The well-known name or unique name that the manager is for.
public string? name_owner { owned get; }
The unique name that owns name or null if no-one is currently owning the name.
public string object_path { owned get; construct; }
The object path the manager is for.

Static methods:

public static async DBusObjectManagerClient @new (DBusConnection connection, DBusObjectManagerClientFlags flags, string name, string object_path, owned DBusProxyTypeFunc? get_proxy_type_func, Cancellable? cancellable = null) throws Error
Asynchronously creates a new DBusObjectManagerClient object.
public static async DBusObjectManagerClient new_for_bus (BusType bus_type, DBusObjectManagerClientFlags flags, string name, string object_path, owned DBusProxyTypeFunc? get_proxy_type_func, Cancellable? cancellable = null) throws Error
Like @new but takes a BusType instead of a DBusConnection.

Creation methods:

public async DBusObjectManagerClient (DBusConnection connection, DBusObjectManagerClientFlags flags, string name, string object_path, owned DBusProxyTypeFunc? get_proxy_type_func, Cancellable? cancellable = null) throws Error
public async DBusObjectManagerClient.for_bus (BusType bus_type, DBusObjectManagerClientFlags flags, string name, string object_path, owned DBusProxyTypeFunc? get_proxy_type_func, Cancellable? cancellable = null) throws Error
public DBusObjectManagerClient.for_bus_sync (BusType bus_type, DBusObjectManagerClientFlags flags, string name, string object_path, owned DBusProxyTypeFunc? get_proxy_type_func, Cancellable? cancellable = null) throws Error
Like DBusObjectManagerClient.sync but takes a BusType instead of a DBusConnection.
public DBusObjectManagerClient.sync (DBusConnection connection, DBusObjectManagerClientFlags flags, string? name, string object_path, owned DBusProxyTypeFunc? get_proxy_type_func, Cancellable? cancellable = null) throws Error
Creates a new DBusObjectManagerClient object.

Methods:

public unowned DBusConnection get_connection ()
Gets the DBusConnection used by this.
public DBusObjectManagerClientFlags get_flags ()
Gets the flags that this was constructed with.
public unowned string get_name ()
Gets the name that this is for, or null if not a message bus connection.
public string? get_name_owner ()
The unique name that owns the name that this is for or null if no-one currently owns that name.

Signals:

public virtual signal void interface_proxy_properties_changed (DBusObjectProxy object_proxy, DBusProxy interface_proxy, Variant changed_properties, string[] invalidated_properties)
Emitted when one or more D-Bus properties on proxy changes.
public virtual signal void interface_proxy_signal (DBusObjectProxy object_proxy, DBusProxy interface_proxy, string sender_name, string signal_name, Variant parameters)
Emitted when a D-Bus signal is received on interface_proxy.

Inherited Members:

All known members inherited from class GLib.Object

All known members inherited from interface GLib.AsyncInitable

new_valist_async

newv_async

All known members inherited from interface GLib.DBusObjectManager

All known members inherited from interface GLib.Initable

@new
init

new_valist

newv