Class: Gio::DBusObjectManagerServer

Inherits:

Object

• Object
• Gio::DBusObjectManagerServer

Defined in:

(unknown)

Overview

Class structure for GDBus::ObjectManagerServer.

Instance Method Summary

• #connection ⇒ Gio::DBusConnection

  The GDBus::Connection to export objects on.

• #connection=(connection) ⇒ Gio::DBusConnection

  The GDBus::Connection to export objects on.

• #export(object) ⇒ nil

  Exports object on manager.

• #export_uniquely(object) ⇒ nil

  Like g_dbus_object_manager_server_export() but appends a string of the form _N (with N being a natural number) to object’s object path if an object with the given path already exists.

• #is_exported(object) ⇒ TrueClass

  Returns whether object is currently exported on manager.

• #new(object_path) ⇒ Gio::DBusObjectManagerServer

  Creates a new GDBus::ObjectManagerServer object.

• #object_path ⇒ String

  The object path to register the manager object at.

• #object_path=(object_path) ⇒ String

  The object path to register the manager object at.

• #unexport(object_path) ⇒ TrueClass

  If manager has an object at path, removes the object.

Instance Method Details

#connection ⇒ Gio::DBusConnection

The GDBus::Connection to export objects on.

Returns:

• (Gio::DBusConnection) —

  connection

#connection=(connection) ⇒ Gio::DBusConnection

The GDBus::Connection to export objects on.

Parameters:

• connection (Gio::DBusConnection)

Returns:

• (Gio::DBusConnection) —

  connection

• (Gio::DBusConnection) —

  connection

#export(object) ⇒ nil

Exports object on manager.

If there is already a GDBus::Object exported at the object path, then the old object is removed.

The object path for object must be in the hierarchy rooted by the object path for manager.

Note that manager will take a reference on object for as long as it is exported.

Parameters:

• object (Gio::DBusObjectSkeleton) —

  A GDBus::ObjectSkeleton.

Returns:

• (nil)

#export_uniquely(object) ⇒ nil

Like g_dbus_object_manager_server_export() but appends a string of the form _N (with N being a natural number) to object’s object path if an object with the given path already exists. As such, the GDBus::ObjectProxy:g-object-path property of object may be modified.

Parameters:

• object (Gio::DBusObjectSkeleton) —

  An object.

Returns:

• (nil)

#is_exported(object) ⇒ TrueClass

Returns whether object is currently exported on manager.

Parameters:

• object (Gio::DBusObjectSkeleton) —

  An object.

Returns:

• (TrueClass) —

  true if object is exported

#new(object_path) ⇒ Gio::DBusObjectManagerServer

Creates a new GDBus::ObjectManagerServer object.

The returned server isn’t yet exported on any connection. To do so, use g_dbus_object_manager_server_set_connection(). Normally you want to export all of your objects before doing so to avoid [InterfacesAdded](dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-objectmanager) signals being emitted.

Parameters:

• object_path (String) —

  The object path to export the manager object at.

Returns:

• (Gio::DBusObjectManagerServer) —

  A GDBus::ObjectManagerServer object. Free with g_object_unref().

#object_path ⇒ String

The object path to register the manager object at.

Returns:

• (String) —

  object-path

#object_path=(object_path) ⇒ String

The object path to register the manager object at.

Parameters:

• object_path (String)

Returns:

• (String) —

  object-path

• (String) —

  object-path

#unexport(object_path) ⇒ TrueClass

If manager has an object at path, removes the object. Otherwise does nothing.

Note that object_path must be in the hierarchy rooted by the object path for manager.

Parameters:

• object_path (String) —

  An object path.

Returns:

• (TrueClass) —

  true if object at object_path was removed, false otherwise.