Gjsify LogoGjsify Logo

Information about a D-Bus interface.

record

Hierarchy

  • DBusInterfaceInfo

Index

Constructors

Properties

annotations: DBusAnnotationInfo[]

A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.

field
methods: DBusMethodInfo[]

A pointer to a %NULL-terminated array of pointers to #GDBusMethodInfo structures or %NULL if there are no methods.

field
name: string

The name of the D-Bus interface, e.g. "org.freedesktop.DBus.Properties".

field
properties: DBusPropertyInfo[]

A pointer to a %NULL-terminated array of pointers to #GDBusPropertyInfo structures or %NULL if there are no properties.

field
refCount: number

The reference count or -1 if statically allocated.

field
signals: DBusSignalInfo[]

A pointer to a %NULL-terminated array of pointers to #GDBusSignalInfo structures or %NULL if there are no signals.

field
name: string

Methods

  • cacheBuild(): void
  • 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.

    Returns void

  • cacheRelease(): void
  • 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.

    Returns void

  • generateXml(indent: number, stringBuilder: GLib.String): void
  • Appends an XML representation of info (and its children) to string_builder.

    This function is typically used for generating introspection XML documents at run-time for handling the org.freedesktop.DBus.Introspectable.Introspect method.

    Parameters

    • indent: number

      Indentation level.

    • stringBuilder: GLib.String

      A #GString to to append XML data to.

    Returns void

  • 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.

    Parameters

    • name: string

      A D-Bus method name (typically in CamelCase)

    Returns DBusMethodInfo

  • 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.

    Parameters

    • name: string

      A D-Bus property name (typically in CamelCase).

    Returns DBusPropertyInfo

  • 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.

    Parameters

    • name: string

      A D-Bus signal name (typically in CamelCase)

    Returns DBusSignalInfo

  • unref(): void
  • If info is statically allocated, does nothing. Otherwise decreases the reference count of info. When its reference count drops to 0, the memory used is freed.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method