dbus_introspect.md

Module dbus_introspect

• Description
• Function Index
• Function Details

API Introspection support module.

Copyright (c) 2006-2007 Mikael Magnusson, 2014-2016 Jean Parpaillon

Authors: Mikael Magnusson (mikma@users.sourceforge.net), Jean Parpaillon (jean.parpaillon@free.fr).

Description

See D-Bus specifications for introspection XML schema.

Function Index

find_interface/2	Find an interface definition.
find_method/3	Find a method definition.
find_signal/3	Find a signal definition.
from_xml/1	Parse a dbus_node() from a filename.
from_xml_string/1	Parse a dbus_node() from an XML string.
to_xml/1	Export a dbus_node() into an XML introspection document.

Function Details

find_interface/2

find_interface(Dbus_node::dbus_node(), Iface::dbus_name()) -> {ok, dbus_iface()} | {error, dbus_err()}

Find an interface definition.

find_method/3

find_method(Dbus_node::dbus_node(), Iface::dbus_name(), Method::dbus_name()) -> {ok, dbus_method()} | {error, dbus_err()}

Find a method definition.

find_signal/3

find_signal(Dbus_node::dbus_node(), Iface::dbus_name(), Signal::dbus_name()) -> {ok, dbus_signal()} | {error, dbus_err()}

Find a signal definition

from_xml/1

from_xml(Filename::file:filename()) -> dbus_node()

throws {error, parse_error}

Parse a dbus_node() from a filename.

from_xml_string/1

from_xml_string(Data::binary()) -> dbus_node()

throws {error, parse_error}

Parse a dbus_node() from an XML string.

to_xml/1

to_xml(Dbus_node::dbus_node()) -> list()

Export a dbus_node() into an XML introspection document.