Class: Gio::DBusObjectManagerClient

Inherits:
Object
  • Object
show all
Defined in:
(unknown)

Overview

Class structure for GDBus::ObjectManagerClient.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection, flags, name, object_path, get_proxy_type_func, get_proxy_type_user_data, get_proxy_type_destroy_notify, cancellable) ⇒ Gio::DBusObjectManagerClient

Creates a new GDBus::ObjectManagerClient object.

This is a synchronous failable constructor - the calling thread is blocked until a reply is received. See g_dbus_object_manager_client_new() for the asynchronous version.

Parameters:

  • connection (Gio::DBusConnection) —

    A GDBus::Connection.

  • flags (Gio::DBusObjectManagerClientFlags) —

    Zero or more flags from the GDBus::ObjectManagerClientFlags enumeration.

  • name (String) —

    The owner of the control object (unique or well-known name), or nil when not using a message bus connection.

  • object_path (String) —

    The object path of the control object.

  • get_proxy_type_func (Gio::DBusProxyTypeFunc) —

    A GDBus::ProxyTypeFunc function or nil to always construct #GDBusProxy proxies.

  • get_proxy_type_user_data (GObject) —

    User data to pass to get_proxy_type_func.

  • get_proxy_type_destroy_notify (GLib::DestroyNotify) —

    Free function for get_proxy_type_user_data or nil.

  • cancellable (Gio::Cancellable) —

    A #GCancellable or nil

Class Method Details

.new(connection, flags, name, object_path, get_proxy_type_func, get_proxy_type_user_data, get_proxy_type_destroy_notify, cancellable, callback, user_data) ⇒ nil

Asynchronously creates a new GDBus::ObjectManagerClient object.

This is an asynchronous failable constructor. When the result is ready, callback will be invoked in the [thread-default main context][g-main-context-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.

Parameters:

  • connection (Gio::DBusConnection) —

    A GDBus::Connection.

  • flags (Gio::DBusObjectManagerClientFlags) —

    Zero or more flags from the GDBus::ObjectManagerClientFlags enumeration.

  • name (String) —

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

  • object_path (String) —

    The object path of the control object.

  • get_proxy_type_func (Gio::DBusProxyTypeFunc) —

    A GDBus::ProxyTypeFunc function or nil to always construct #GDBusProxy proxies.

  • get_proxy_type_user_data (GObject) —

    User data to pass to get_proxy_type_func.

  • get_proxy_type_destroy_notify (GLib::DestroyNotify) —

    Free function for get_proxy_type_user_data or nil.

  • cancellable (Gio::Cancellable) —

    A #GCancellable or nil

  • callback (Gio::AsyncReadyCallback) —

    A GAsync::ReadyCallback to call when the request is satisfied.

  • user_data (GObject) —

    The data to pass to callback.

Returns:

  • (nil)

.new_for_bus(bus_type, flags, name, object_path, get_proxy_type_func, get_proxy_type_user_data, get_proxy_type_destroy_notify, cancellable, callback, user_data) ⇒ nil

Like g_dbus_object_manager_client_new() but takes a GBus::Type instead of a GDBus::Connection.

This is an asynchronous failable constructor. When the result is ready, callback will be invoked in the [thread-default main loop][g-main-context-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.

Parameters:

  • bus_type (Gio::BusType) —

    A GBus::Type.

  • flags (Gio::DBusObjectManagerClientFlags) —

    Zero or more flags from the GDBus::ObjectManagerClientFlags enumeration.

  • name (String) —

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

  • object_path (String) —

    The object path of the control object.

  • get_proxy_type_func (Gio::DBusProxyTypeFunc) —

    A GDBus::ProxyTypeFunc function or nil to always construct #GDBusProxy proxies.

  • get_proxy_type_user_data (GObject) —

    User data to pass to get_proxy_type_func.

  • get_proxy_type_destroy_notify (GLib::DestroyNotify) —

    Free function for get_proxy_type_user_data or nil.

  • cancellable (Gio::Cancellable) —

    A #GCancellable or nil

  • callback (Gio::AsyncReadyCallback) —

    A GAsync::ReadyCallback to call when the request is satisfied.

  • user_data (GObject) —

    The data to pass to callback.

Returns:

  • (nil)

Instance Method Details

#bus_type=(bus_type) ⇒ Gio::BusType

If this property is not %G_BUS_TYPE_NONE, then GDBus::ObjectManagerClient:connection must be nil and will be set to the GDBus::Connection obtained by calling g_bus_get() with the value of this property.

Parameters:

Returns:

#connection ⇒ Gio::DBusConnection

The GDBus::Connection to use.

Returns:

#connection=(connection) ⇒ Gio::DBusConnection

The GDBus::Connection to use.

Parameters:

Returns:

#flags ⇒ Gio::DBusObjectManagerClientFlags

Flags from the GDBus::ObjectManagerClientFlags enumeration.

Returns:

#flags=(flags) ⇒ Gio::DBusObjectManagerClientFlags

Flags from the GDBus::ObjectManagerClientFlags enumeration.

Parameters:

Returns:

#get_proxy_type_destroy_notify ⇒ GObject

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

Returns:

  • (GObject) —

    get-proxy-type-destroy-notify

#get_proxy_type_destroy_notify=(get_proxy_type_destroy_notify) ⇒ GObject

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

Parameters:

  • get_proxy_type_destroy_notify (GObject)

Returns:

  • (GObject) —

    get-proxy-type-destroy-notify

  • (GObject) —

    get-proxy-type-destroy-notify

#get_proxy_type_func ⇒ GObject

The GDBus::ProxyTypeFunc to use when determining what #GType to use for interface proxies or nil.

Returns:

  • (GObject) —

    get-proxy-type-func

#get_proxy_type_func=(get_proxy_type_func) ⇒ GObject

The GDBus::ProxyTypeFunc to use when determining what #GType to use for interface proxies or nil.

Parameters:

  • get_proxy_type_func (GObject)

Returns:

  • (GObject) —

    get-proxy-type-func

  • (GObject) —

    get-proxy-type-func

#get_proxy_type_user_data ⇒ GObject

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

Returns:

  • (GObject) —

    get-proxy-type-user-data

#get_proxy_type_user_data=(get_proxy_type_user_data) ⇒ GObject

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

Parameters:

  • get_proxy_type_user_data (GObject)

Returns:

  • (GObject) —

    get-proxy-type-user-data

  • (GObject) —

    get-proxy-type-user-data

#name ⇒ String

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

Returns:

  • (String) —

    name

#name=(name) ⇒ String

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

Parameters:

  • name (String)

Returns:

  • (String) —

    name

  • (String) —

    name

#name_owner ⇒ String

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

Returns:

  • (String) —

    name-owner

#name_owner=(name_owner) ⇒ String

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

Parameters:

  • name_owner (String)

Returns:

  • (String) —

    name-owner

  • (String) —

    name-owner

#object_path ⇒ String

The object path the manager is for.

Returns:

  • (String) —

    object-path

#object_path=(object_path) ⇒ String

The object path the manager is for.

Parameters:

  • object_path (String)

Returns:

  • (String) —

    object-path

  • (String) —

    object-path