glibmm 2.80.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Symbols | List of all members
Gio::DBus::InterfaceInfo Class Referencefinal

Stores information about a D-Bus interface. More...

#include <giomm/dbusintrospection.h>

Public Member Functions

void reference () const
 Increment the reference count for this object.
 
void unreference () const
 Decrement the reference count for this object.
 
GDBusInterfaceInfogobj ()
 Provides access to the underlying C instance.
 
const GDBusInterfaceInfogobj () const
 Provides access to the underlying C instance.
 
GDBusInterfaceInfogobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
 
 InterfaceInfo ()=delete
 
 InterfaceInfo (const InterfaceInfo &)=delete
 
InterfaceInfooperator= (const InterfaceInfo &)=delete
 
Glib::RefPtr< MethodInfolookup_method (const Glib::ustring & name)
 Looks up information about a method.
 
Glib::RefPtr< const MethodInfolookup_method (const Glib::ustring & name) const
 Looks up information about a method.
 
Glib::RefPtr< SignalInfolookup_signal (const Glib::ustring & name)
 Looks up information about a signal.
 
Glib::RefPtr< const SignalInfolookup_signal (const Glib::ustring & name) const
 Looks up information about a signal.
 
Glib::RefPtr< PropertyInfolookup_property (const Glib::ustring & name)
 Looks up information about a property.
 
Glib::RefPtr< const PropertyInfolookup_property (const Glib::ustring & name) const
 Looks up information about a property.
 
void cache_build ()
 Builds a lookup-cache to speed up g_dbus_interface_info_lookup_method(), g_dbus_interface_info_lookup_signal() and g_dbus_interface_info_lookup_property().
 
void cache_release ()
 Decrements the usage count for the cache for info built by g_dbus_interface_info_cache_build() (if any) and frees the resources used by the cache if the usage count drops to zero.
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 

Protected Member Functions

void operator delete (void *, std::size_t)
 

Related Symbols

(Note that these are not member symbols.)

Glib::RefPtr< Gio::DBus::InterfaceInfowrap (GDBusInterfaceInfo *object, bool take_copy=false)
 A Glib::wrap() method for this object.
 

Detailed Description

Stores information about a D-Bus interface.

Since glibmm 2.28:

Constructor & Destructor Documentation

◆ InterfaceInfo() [1/2]

Gio::DBus::InterfaceInfo::InterfaceInfo ( )
delete

◆ InterfaceInfo() [2/2]

Gio::DBus::InterfaceInfo::InterfaceInfo ( const InterfaceInfo )
delete

Member Function Documentation

◆ cache_build()

void Gio::DBus::InterfaceInfo::cache_build ( )

Builds a lookup-cache to speed up g_dbus_interface_info_lookup_method(), g_dbus_interface_info_lookup_signal() and g_dbus_interface_info_lookup_property().

If this has already been called with info, the existing cache is used and its use count is increased.

Note that info cannot be modified until g_dbus_interface_info_cache_release() is called.

Since glibmm 2.44:

◆ cache_release()

void Gio::DBus::InterfaceInfo::cache_release ( )

Decrements the usage count for the cache for info built by g_dbus_interface_info_cache_build() (if any) and frees the resources used by the cache if the usage count drops to zero.

Since glibmm 2.44:

◆ get_type()

static GType Gio::DBus::InterfaceInfo::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GDBusInterfaceInfo * Gio::DBus::InterfaceInfo::gobj ( )

Provides access to the underlying C instance.

◆ gobj() [2/2]

const GDBusInterfaceInfo * Gio::DBus::InterfaceInfo::gobj ( ) const

Provides access to the underlying C instance.

◆ gobj_copy()

GDBusInterfaceInfo * Gio::DBus::InterfaceInfo::gobj_copy ( ) const

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ lookup_method() [1/2]

Glib::RefPtr< MethodInfo > Gio::DBus::InterfaceInfo::lookup_method ( const Glib::ustring name)

Looks up information about a method.

The cost of this function is O(n) in number of methods unless g_dbus_interface_info_cache_build() has been used on info.

Since glibmm 2.26:
Parameters
nameA D-Bus method name (typically in CamelCase).
Returns
A DBusMethodInfo or nullptr if not found. Do not free, it is owned by info.

◆ lookup_method() [2/2]

Glib::RefPtr< const MethodInfo > Gio::DBus::InterfaceInfo::lookup_method ( const Glib::ustring name) const

Looks up information about a method.

The cost of this function is O(n) in number of methods unless g_dbus_interface_info_cache_build() has been used on info.

Since glibmm 2.26:
Parameters
nameA D-Bus method name (typically in CamelCase).
Returns
A DBusMethodInfo or nullptr if not found. Do not free, it is owned by info.

◆ lookup_property() [1/2]

Glib::RefPtr< PropertyInfo > Gio::DBus::InterfaceInfo::lookup_property ( const Glib::ustring name)

Looks up information about a property.

The cost of this function is O(n) in number of properties unless g_dbus_interface_info_cache_build() has been used on info.

Since glibmm 2.26:
Parameters
nameA D-Bus property name (typically in CamelCase).
Returns
A DBusPropertyInfo or nullptr if not found. Do not free, it is owned by info.

◆ lookup_property() [2/2]

Glib::RefPtr< const PropertyInfo > Gio::DBus::InterfaceInfo::lookup_property ( const Glib::ustring name) const

Looks up information about a property.

The cost of this function is O(n) in number of properties unless g_dbus_interface_info_cache_build() has been used on info.

Since glibmm 2.26:
Parameters
nameA D-Bus property name (typically in CamelCase).
Returns
A DBusPropertyInfo or nullptr if not found. Do not free, it is owned by info.

◆ lookup_signal() [1/2]

Glib::RefPtr< SignalInfo > Gio::DBus::InterfaceInfo::lookup_signal ( const Glib::ustring name)

Looks up information about a signal.

The cost of this function is O(n) in number of signals unless g_dbus_interface_info_cache_build() has been used on info.

Since glibmm 2.26:
Parameters
nameA D-Bus signal name (typically in CamelCase).
Returns
A DBusSignalInfo or nullptr if not found. Do not free, it is owned by info.

◆ lookup_signal() [2/2]

Glib::RefPtr< const SignalInfo > Gio::DBus::InterfaceInfo::lookup_signal ( const Glib::ustring name) const

Looks up information about a signal.

The cost of this function is O(n) in number of signals unless g_dbus_interface_info_cache_build() has been used on info.

Since glibmm 2.26:
Parameters
nameA D-Bus signal name (typically in CamelCase).
Returns
A DBusSignalInfo or nullptr if not found. Do not free, it is owned by info.

◆ operator delete()

void Gio::DBus::InterfaceInfo::operator delete ( void ,
std::size_t   
)
protected

◆ operator=()

InterfaceInfo & Gio::DBus::InterfaceInfo::operator= ( const InterfaceInfo )
delete

◆ reference()

void Gio::DBus::InterfaceInfo::reference ( ) const

Increment the reference count for this object.

You should never need to do this manually - use the object via a RefPtr instead.

◆ unreference()

void Gio::DBus::InterfaceInfo::unreference ( ) const

Decrement the reference count for this object.

You should never need to do this manually - use the object via a RefPtr instead.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gio::DBus::InterfaceInfo > wrap ( GDBusInterfaceInfo object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.