Class: Gio::DBusInterfaceSkeleton

Inherits:

Object

• Object
• Gio::DBusInterfaceSkeleton

Defined in:

(unknown)

Overview

Class structure for GDBus::InterfaceSkeleton.

Instance Method Summary

• #connection ⇒ Gio::DBusConnection

  Gets the first connection that interface_ is exported on, if any.

• #connections ⇒ GLib::List

  Gets a list of the connections that interface_ is exported on.

• #export(connection, object_path) ⇒ TrueClass

  Exports interface_ at object_path on connection.

• #flags ⇒ Gio::DBusInterfaceSkeletonFlags

  Gets the GDBus::InterfaceSkeletonFlags that describes what the behavior of interface_.

• #flags=(flags) ⇒ nil

  Sets flags describing what the behavior of skeleton should be.

• #flush ⇒ nil

  If interface_ has outstanding changes, request for these changes to be emitted immediately.

• #g_flags ⇒ Gio::DBusInterfaceSkeletonFlags

  Flags from the GDBus::InterfaceSkeletonFlags enumeration.

• #g_flags=(g_flags) ⇒ Gio::DBusInterfaceSkeletonFlags

  Flags from the GDBus::InterfaceSkeletonFlags enumeration.

• #has_connection(connection) ⇒ TrueClass

  Checks if interface_ is exported on connection.

• #info ⇒ Gio::DBusInterfaceInfo

  Gets D-Bus introspection information for the D-Bus interface implemented by interface_.

• #object_path ⇒ String

  Gets the object path that interface_ is exported on, if any.

• #properties ⇒ GLib::Variant

  Gets all D-Bus properties for interface_.

• #unexport ⇒ nil

  Stops exporting interface_ on all connections it is exported on.

• #unexport_from_connection(connection) ⇒ nil

  Stops exporting interface_ on connection.

• #vtable ⇒ Gio::DBusInterfaceVTable

  Gets the interface vtable for the D-Bus interface implemented by interface_.

Instance Method Details

#connection ⇒ Gio::DBusConnection

Gets the first connection that interface_ is exported on, if any. not exported anywhere. Do not free, the object belongs to interface_.

Returns:

• (Gio::DBusConnection) —

  A GDBus::Connection or nil if interface_ is

#connections ⇒ GLib::List

Gets a list of the connections that interface_ is exported on.

Returns:

• (GLib::List) —

  A list of all the connections that interface_ is exported on. The returned list should be freed with g_list_free() after each element has been freed with g_object_unref().

#export(connection, object_path) ⇒ TrueClass

Exports interface_ at object_path on connection.

This can be called multiple times to export the same interface_ onto multiple connections however the object_path provided must be the same for all connections.

Use g_dbus_interface_skeleton_unexport() to unexport the object. error set.

Parameters:

• connection (Gio::DBusConnection) —

  A GDBus::Connection to export interface_ on.

• object_path (String) —

  The path to export the interface at.

Returns:

• (TrueClass) —

  true if the interface was exported on connection, otherwise false with

#flags ⇒ Gio::DBusInterfaceSkeletonFlags

Gets the GDBus::InterfaceSkeletonFlags that describes what the behavior of interface_

Returns:

• (Gio::DBusInterfaceSkeletonFlags) —

  One or more flags from the GDBus::InterfaceSkeletonFlags enumeration.

#flags=(flags) ⇒ nil

Sets flags describing what the behavior of skeleton should be.

Parameters:

• flags (Gio::DBusInterfaceSkeletonFlags) —

  Flags from the GDBus::InterfaceSkeletonFlags enumeration.

Returns:

• (nil)

#flush ⇒ nil

If interface_ has outstanding changes, request for these changes to be emitted immediately.

For example, an exported D-Bus interface may queue up property changes and emit the ‘org.freedesktop.DBus.Properties.PropertiesChanged` signal later (e.g. in an idle handler). This technique is useful for collapsing multiple property changes into one.

Returns:

• (nil)

#g_flags ⇒ Gio::DBusInterfaceSkeletonFlags

Flags from the GDBus::InterfaceSkeletonFlags enumeration.

Returns:

• (Gio::DBusInterfaceSkeletonFlags) —

  g-flags

#g_flags=(g_flags) ⇒ Gio::DBusInterfaceSkeletonFlags

Flags from the GDBus::InterfaceSkeletonFlags enumeration.

Parameters:

• g_flags (Gio::DBusInterfaceSkeletonFlags)

Returns:

• (Gio::DBusInterfaceSkeletonFlags) —

  g-flags

• (Gio::DBusInterfaceSkeletonFlags) —

  g-flags

#has_connection(connection) ⇒ TrueClass

Checks if interface_ is exported on connection.

Parameters:

• connection (Gio::DBusConnection) —

  A GDBus::Connection.

Returns:

• (TrueClass) —

  true if interface_ is exported on connection, false otherwise.

#info ⇒ Gio::DBusInterfaceInfo

Gets D-Bus introspection information for the D-Bus interface implemented by interface_.

Returns:

• (Gio::DBusInterfaceInfo) —

  A GDBus::InterfaceInfo (never nil). Do not free.

#object_path ⇒ String

Gets the object path that interface_ is exported on, if any. anywhere. Do not free, the string belongs to interface_.

Returns:

• (String) —

  A string owned by interface_ or nil if interface_ is not exported

#properties ⇒ GLib::Variant

Gets all D-Bus properties for interface_. [‘asv’][G-VARIANT-TYPE-VARDICT:CAPS]. Free with g_variant_unref().

Returns:

• (GLib::Variant) —

  A #GVariant of type

#unexport ⇒ nil

Stops exporting interface_ on all connections it is exported on.

To unexport interface_ from only a single connection, use g_dbus_interface_skeleton_unexport_from_connection()

Returns:

• (nil)

#unexport_from_connection(connection) ⇒ nil

Stops exporting interface_ on connection.

To stop exporting on all connections the interface is exported on, use g_dbus_interface_skeleton_unexport().

Parameters:

• connection (Gio::DBusConnection) —

  A GDBus::Connection.

Returns:

• (nil)

#vtable ⇒ Gio::DBusInterfaceVTable

Gets the interface vtable for the D-Bus interface implemented by interface_. The returned function pointers should expect interface_ itself to be passed as user_data.

Returns:

• (Gio::DBusInterfaceVTable) —

  A GDBus::InterfaceVTable (never nil).