Class DBus

Generic interface to the DBUS system.

class DBus

Summary

initGeneric interface to the DBUS system.
addMatch()Adds an active filter for incoming signals.
dispatch()Perform a dispatch loop on message queues.
invoke()Invoke a remote DBUS method.
removeMatch()Removes an active filter for incoming signals.
signal()Broadcast a message directed to all the potential DBUS listeners.

Init Block

Generic interface to the DBUS system.

init DBus

Methods

addMatch()

Adds an active filter for incoming signals.

DBus.addMatch( [rule] )

ruleThe filter rule in DBUS rule specification format.
Raises:
DBusErrorin case of failure.

Set rule to nil or leave empty to perform a "full filter" request.

See the dbus_bus_add_match() description in the official DBUS low level documentation.

dispatch()

Perform a dispatch loop on message queues.

DBus.dispatch( [timeout] )

timeoutAn optional timeout to be idle for messages to be sent or receive.
Raises:
DBusErrorin case of failure.

Set timeout to zero (or empty) to just dispatch ready messages, or to -1 to wait forever. Otherwise, waits for seconds and fractions.

invoke()

Invoke a remote DBUS method.

DBus.invoke( destination, path, interface, name, ... )

destinationWell known name of the service provider where the method is searched.
pathPath to the object in the service provider.
interfaceInterface in which the method is searched.
nameMethod name.
...Parameters for the method invocation.
Returns: an instance of DBusPendingCall class.
Raises:
DBusErrorin case of failure.

Use the returned instance to wait for a reply.

removeMatch()

Removes an active filter for incoming signals.

DBus.removeMatch( [rule] )

ruleThe filter rule in DBUS rule specification format.
Raises:
DBusErrorin case of failure.

Set rule to nil or leave empty to remove a previous "full filter" request.

See the dbus_bus_remove_match() description in the official DBUS low level documentation.

signal()

Broadcast a message directed to all the potential DBUS listeners.

DBus.signal( path, interface, name, ... )

paththe path from the object emitting the signal
interfacethe interface the signal is emitted from
namename of the signal
...Parameters for the signal.
Raises:
DBusErrorin case of failure.

Made with faldoc 2.1.0