Struct DBusObjectManagerClient 

pub struct DBusObjectManagerClient { /* private fields */ }

GDBusObjectManagerClient is used to create, monitor and delete object proxies for remote objects exported by a 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 object-added and object-removed signals] and inspect the DBusObjectProxy objects returned by DBusObjectManagerExt::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. DBusObjectManagerExt::objects() returns the empty list) and the 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 notify signal to watch for changes on the name-owner property. When the name owner vanishes, the behavior is that name-owner is set to NULL (this includes emission of the notify signal) and then object-removed signals are synthesized for all currently existing object proxies. Since 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 DBusObjectManager. Similarly, when a new name owner appears, object-added signals are synthesized while name-owner is still NULL. Only when all object proxies have been added, the name-owner is set to the new name owner (this includes emission of the notify signal). Furthermore, you are guaranteed that 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 DBusProxy instances. All signals (including the org.freedesktop.DBus.Properties::PropertiesChanged signal) delivered to 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 DBusObjectProxy and DBusProxy objects, the interface-added, interface-removed, g-properties-changed and g-signal signals are also emitted on the GDBusObjectManagerClient instance managing these objects. The signals emitted are interface-added, interface-removed, interface-proxy-properties-changed and interface-proxy-signal.

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

Properties

bus-type

If this property is not BusType::None, then #GDBusObjectManagerClient:connection must be None and will be set to the #GDBusConnection obtained by calling g_bus_get() with the value of this property.

Writeable | Construct Only

connection

The #GDBusConnection to use.

Readable | Writeable | Construct Only

flags

Flags from the #GDBusObjectManagerClientFlags enumeration.

Readable | Writeable | Construct Only

get-proxy-type-destroy-notify

A #GDestroyNotify for the #gpointer user_data in #GDBusObjectManagerClient:get-proxy-type-user-data.

Readable | Writeable | Construct Only

get-proxy-type-func

The #GDBusProxyTypeFunc to use when determining what #GType to use for interface proxies or None.

Readable | Writeable | Construct Only

get-proxy-type-user-data

The #gpointer user_data to pass to #GDBusObjectManagerClient:get-proxy-type-func.

Readable | Writeable | Construct Only

name

The well-known name or unique name that the manager is for.

Readable | Writeable | Construct Only

name-owner

The unique name that owns #GDBusObjectManagerClient:name or None if no-one is currently owning the name. Connect to the #GObject::notify signal to track changes to this property.

Readable

object-path

The object path the manager is for.

Readable | Writeable | Construct Only

Signals

interface-proxy-properties-changed

Emitted when one or more D-Bus properties on proxy changes. The local cache has already been updated when this signal fires. Note that both @changed_properties and @invalidated_properties are guaranteed to never be None (either may be empty though).

This signal exists purely as a convenience to avoid having to connect signals to all interface proxies managed by @manager.

This signal is emitted in the thread-default main context (see [glib::MainContext::push_thread_default()][crate::glib::MainContext::push_thread_default()]) that @manager was constructed in.

interface-proxy-signal

Emitted when a D-Bus signal is received on @interface_proxy.

This signal exists purely as a convenience to avoid having to connect signals to all interface proxies managed by @manager.

This signal is emitted in the thread-default main context (see [glib::MainContext::push_thread_default()][crate::glib::MainContext::push_thread_default()]) that @manager was constructed in.

DBusObjectManager

interface-added

Emitted when @interface is added to @object.

This signal exists purely as a convenience to avoid having to connect signals to all objects managed by @manager.

interface-removed

Emitted when @interface has been removed from @object.

This signal exists purely as a convenience to avoid having to connect signals to all objects managed by @manager.

object-added

Emitted when @object is added to @manager.

object-removed

Emitted when @object is removed from @manager.

Implements

DBusObjectManagerClientExt, [trait@glib::ObjectExt], AsyncInitableExt, DBusObjectManagerExt, InitableExt, DBusObjectManagerClientExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl DBusObjectManagerClient

pub fn new_sync( connection: &DBusConnection, flags: DBusObjectManagerClientFlags, name: Option<&str>, object_path: &str, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<DBusObjectManagerClient, Error>

pub fn new_sync_with_fn<F: Fn(&DBusObjectManagerClient, &str, Option<&str>) -> Type + Send + Sync + 'static>( connection: &DBusConnection, flags: DBusObjectManagerClientFlags, name: Option<&str>, object_path: &str, get_proxy_type_func: F, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<DBusObjectManagerClient, Error>

pub fn for_bus_sync( bus_type: BusType, flags: DBusObjectManagerClientFlags, name: &str, object_path: &str, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<DBusObjectManagerClient, Error>

pub fn for_bus_sync_with_fn<F: Fn(&DBusObjectManagerClient, &str, Option<&str>) -> Type + Send + Sync + 'static>( bus_type: BusType, flags: DBusObjectManagerClientFlags, name: &str, object_path: &str, get_proxy_type_func: F, cancellable: Option<&impl IsA<Cancellable>>, ) -> Result<DBusObjectManagerClient, Error>

pub fn new<P: FnOnce(Result<DBusObjectManagerClient, Error>) + Send + Sync + 'static>( connection: &DBusConnection, flags: DBusObjectManagerClientFlags, name: &str, object_path: &str, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

Asynchronously creates a new #GDBusObjectManagerClient object.

This is an asynchronous failable constructor. When the result is ready, @callback will be invoked in the thread-default main context (see [glib::MainContext::push_thread_default()][crate::glib::MainContext::push_thread_default()]) of the thread you are calling this method from. You can then call g_dbus_object_manager_client_new_finish() to get the result. See g_dbus_object_manager_client_new_sync() for the synchronous version.

connection

A #GDBusConnection.

flags

Zero or more flags from the #GDBusObjectManagerClientFlags enumeration.

name

The owner of the control object (unique or well-known name).

object_path

The object path of the control object.

get_proxy_type_func

A #GDBusProxyTypeFunc function or None to always construct #GDBusProxy proxies.

get_proxy_type_user_data

User data to pass to @get_proxy_type_func.

get_proxy_type_destroy_notify

Free function for @get_proxy_type_user_data or None.

cancellable

A #GCancellable or None

callback

A #GAsyncReadyCallback to call when the request is satisfied.

pub fn new_with_fn<P: FnOnce(Result<DBusObjectManagerClient, Error>) + Send + Sync + 'static, F: Fn(&DBusObjectManagerClient, &str, Option<&str>) -> Type + Send + Sync + 'static>( connection: &DBusConnection, flags: DBusObjectManagerClientFlags, name: &str, object_path: &str, get_proxy_type_func: F, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

pub fn new_future( connection: &DBusConnection, flags: DBusObjectManagerClientFlags, name: &str, object_path: &str, ) -> Pin<Box<dyn Future<Output = Result<DBusObjectManagerClient, Error>> + 'static>>

pub fn new_future_with_fn<F: Fn(&DBusObjectManagerClient, &str, Option<&str>) -> Type + Send + Sync + 'static>( connection: &DBusConnection, flags: DBusObjectManagerClientFlags, name: &str, object_path: &str, get_proxy_type_func: F, ) -> Pin<Box<dyn Future<Output = Result<DBusObjectManagerClient, Error>> + 'static>>

pub fn new_for_bus<P: FnOnce(Result<DBusObjectManagerClient, Error>) + Send + Sync + 'static>( bus_type: BusType, flags: DBusObjectManagerClientFlags, name: &str, object_path: &str, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

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

This is an asynchronous failable constructor. When the result is ready, @callback will be invoked in the thread-default main context (see [glib::MainContext::push_thread_default()][crate::glib::MainContext::push_thread_default()]) of the thread you are calling this method from. You can then call g_dbus_object_manager_client_new_for_bus_finish() to get the result. See g_dbus_object_manager_client_new_for_bus_sync() for the synchronous version.

bus_type

A #GBusType.

flags

Zero or more flags from the #GDBusObjectManagerClientFlags enumeration.

name

The owner of the control object (unique or well-known name).

object_path

The object path of the control object.

get_proxy_type_func

A #GDBusProxyTypeFunc function or None to always construct #GDBusProxy proxies.

get_proxy_type_user_data

User data to pass to @get_proxy_type_func.

get_proxy_type_destroy_notify

Free function for @get_proxy_type_user_data or None.

cancellable

A #GCancellable or None

callback

A #GAsyncReadyCallback to call when the request is satisfied.

pub fn new_for_bus_with_fn<P: FnOnce(Result<DBusObjectManagerClient, Error>) + Send + Sync + 'static, F: Fn(&DBusObjectManagerClient, &str, Option<&str>) -> Type + Send + Sync + 'static>( bus_type: BusType, flags: DBusObjectManagerClientFlags, name: &str, object_path: &str, get_proxy_type_func: F, cancellable: Option<&impl IsA<Cancellable>>, callback: P, )

pub fn new_for_bus_future( bus_type: BusType, flags: DBusObjectManagerClientFlags, name: &str, object_path: &str, ) -> Pin<Box<dyn Future<Output = Result<DBusObjectManagerClient, Error>> + 'static>>

pub fn new_for_bus_future_with_fn<F: Fn(&DBusObjectManagerClient, &str, Option<&str>) -> Type + Send + Sync + 'static>( bus_type: BusType, flags: DBusObjectManagerClientFlags, name: &str, object_path: &str, get_proxy_type_func: F, ) -> Pin<Box<dyn Future<Output = Result<DBusObjectManagerClient, Error>> + 'static>>

impl DBusObjectManagerClient

pub const NONE: Option<&'static DBusObjectManagerClient> = None

Trait Implementations

impl Clone for DBusObjectManagerClient

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DBusObjectManagerClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for DBusObjectManagerClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for DBusObjectManagerClient

type ParamSpec = ParamSpecObject

type SetValue = DBusObjectManagerClient

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, DBusObjectManagerClient>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DBusObjectManagerClient

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DBusObjectManagerClient

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for DBusObjectManagerClient

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for DBusObjectManagerClient

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for DBusObjectManagerClient

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for DBusObjectManagerClient

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DBusObjectManagerClient

impl IsA<AsyncInitable> for DBusObjectManagerClient

impl IsA<DBusObjectManager> for DBusObjectManagerClient

impl IsA<Initable> for DBusObjectManagerClient

impl Send for DBusObjectManagerClient

impl Sync for DBusObjectManagerClient