class Gio::DBusObjectManagerClient

• Gio::DBusObjectManagerClient
• GObject::Object
• Reference
• Object

Overview

#GDBusObjectManagerClient is used to create, monitor and delete object proxies for remote objects exported by a #GDBusObjectManagerServer (or any code implementing the org.freedesktop.DBus.ObjectManager interface).

Once an instance of this type has been created, you can connect to the #GDBusObjectManager::object-added and #GDBusObjectManager::object-removed signals and inspect the #GDBusObjectProxy objects returned by g_dbus_object_manager_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. g_dbus_object_manager_get_objects() returns the empty list) and the #GDBusObjectManagerClient:name-owner property is nil.

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 #GObject::notify signal to watch for changes on the #GDBusObjectManagerClient:name-owner property. When the name owner vanishes, the behavior is that #GDBusObjectManagerClient:name-owner is set to nil (this includes emission of the #GObject::notify signal) and then #GDBusObjectManager::object-removed signals are synthesized for all currently existing object proxies. Since #GDBusObjectManagerClient:name-owner is nil when this happens, you can use this information to disambiguate a synthesized signal from a genuine signal caused by object removal on the remote #GDBusObjectManager. Similarly, when a new name owner appears, #GDBusObjectManager::object-added signals are synthesized while #GDBusObjectManagerClient:name-owner is still nil. Only when all object proxies have been added, the #GDBusObjectManagerClient:name-owner is set to the new name owner (this includes emission of the #GObject::notify signal). Furthermore, you are guaranteed that #GDBusObjectManagerClient:name-owner will alternate between a name owner (e.g. :1.42) and nil even in the case where the name of interest is atomically replaced

Ultimately, #GDBusObjectManagerClient is used to obtain #GDBusProxy instances. All signals (including the org.freedesktop.DBus.Properties::PropertiesChanged signal) delivered to #GDBusProxy 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 #GDBusObjectProxy and #GDBusProxy objects, the #GDBusObject::interface-added, #GDBusObject::interface-removed, #GDBusProxy::g-properties-changed and #GDBusProxy::g-signal signals are also emitted on the #GDBusObjectManagerClient instance managing these objects. The signals emitted are #GDBusObjectManager::interface-added, #GDBusObjectManager::interface-removed, #GDBusObjectManagerClient::interface-proxy-properties-changed and #GDBusObjectManagerClient::interface-proxy-signal.

Note that all callbacks and signals are emitted in the [thread-default main context][g-main-context-push-thread-default] that the #GDBusObjectManagerClient object was constructed in. Additionally, the #GDBusObjectProxy and #GDBusProxy objects originating from the #GDBusObjectManagerClient object will be created in the same context and, consequently, will deliver signals in the same main loop.

Included Modules

• Gio::AsyncInitable
• Gio::DBusObjectManager
• Gio::Initable

Defined in:

Constructors

• .new

  Initialize a new DBusObjectManagerClient.

• .new(*, bus_type : Gio::BusType | Nil = nil, connection : Gio::DBusConnection | Nil = nil, flags : Gio::DBusObjectManagerClientFlags | Nil = nil, get_proxy_type_destroy_notify : Pointer(Void) | Nil = nil, get_proxy_type_func : Pointer(Void) | Nil = nil, get_proxy_type_user_data : Pointer(Void) | Nil = nil, name : String | Nil = nil, name_owner : String | Nil = nil, object_path : String | Nil = nil)
• .new(connection : Gio::DBusConnection, flags : Gio::DBusObjectManagerClientFlags, name : String, object_path : String, get_proxy_type_func : Gio::DBusProxyTypeFunc | Nil, get_proxy_type_user_data : Pointer(Void) | Nil, get_proxy_type_destroy_notify : GLib::DestroyNotify | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil

  Asynchronously creates a new #GDBusObjectManagerClient object.

• .new_finish(res : Gio::AsyncResult) : self

  Finishes an operation started with g_dbus_object_manager_client_new().

• .new_for_bus_finish(res : Gio::AsyncResult) : self

  Finishes an operation started with g_dbus_object_manager_client_new_for_bus().

• .new_for_bus_sync(bus_type : Gio::BusType, flags : Gio::DBusObjectManagerClientFlags, name : String, object_path : String, get_proxy_type_func : Gio::DBusProxyTypeFunc | Nil, get_proxy_type_user_data : Pointer(Void) | Nil, get_proxy_type_destroy_notify : GLib::DestroyNotify | Nil, cancellable : Gio::Cancellable | Nil) : self

  Like g_dbus_object_manager_client_new_sync() but takes a #GBusType instead of a #GDBusConnection.

• .new_sync(connection : Gio::DBusConnection, flags : Gio::DBusObjectManagerClientFlags, name : String | Nil, object_path : String, get_proxy_type_func : Gio::DBusProxyTypeFunc | Nil, get_proxy_type_user_data : Pointer(Void) | Nil, get_proxy_type_destroy_notify : GLib::DestroyNotify | Nil, cancellable : Gio::Cancellable | Nil) : self

  Creates a new #GDBusObjectManagerClient object.

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

• .new_for_bus(bus_type : Gio::BusType, flags : Gio::DBusObjectManagerClientFlags, name : String, object_path : String, get_proxy_type_func : Gio::DBusProxyTypeFunc | Nil, get_proxy_type_user_data : Pointer(Void) | Nil, get_proxy_type_destroy_notify : GLib::DestroyNotify | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil

  Like g_dbus_object_manager_client_new() but takes a #GBusType instead of a #GDBusConnection.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #bus_type=(value : Gio::BusType) : Gio::BusType
• #connection : Gio::DBusConnection

  Gets the #GDBusConnection used by manager.

• #connection=(value : Gio::DBusConnection | Nil) : Gio::DBusConnection | Nil
• #flags : Gio::DBusObjectManagerClientFlags

  Gets the flags that manager was constructed with.

• #flags=(value : Gio::DBusObjectManagerClientFlags) : Gio::DBusObjectManagerClientFlags
• #get_proxy_type_destroy_notify : Pointer(Void)
• #get_proxy_type_destroy_notify=(value : Pointer(Void)) : Pointer(Void)
• #get_proxy_type_func : Pointer(Void)
• #get_proxy_type_func=(value : Pointer(Void)) : Pointer(Void)
• #get_proxy_type_user_data : Pointer(Void)
• #get_proxy_type_user_data=(value : Pointer(Void)) : Pointer(Void)
• #hash(hasher)

  See Object#hash(hasher)

• #interface_proxy_properties_changed_signal
• #interface_proxy_signal_signal
• #name : String

  Gets the name that manager is for, or nil if not a message bus connection.

• #name=(value : String) : String
• #name=(value : Nil) : Nil

  Set #name property to nil.

• #name? : String | Nil

  Same as #name, but can return nil.

• #name_owner : String | Nil

  The unique name that owns the name that manager is for or nil if no-one currently owns that name.

• #name_owner? : String | Nil

  Same as #name_owner, but can return nil.

• #object_path : String
• #object_path=(value : String) : String
• #object_path=(value : Nil) : Nil

  Set #object_path property to nil.

• #object_path? : String | Nil

  Same as #object_path, but can return nil.

Constructor Detail

Class Method Detail

Instance Method Detail