Home · All Classes · Main Classes · Grouped Classes · Modules · Functions

Using QtDBus Adaptors

Adaptors are special classes that are attached to any QObject-derived class and provide the interface to the external world using D-BUS. Adaptors are intended to be lightweight classes whose main purpose is to relay calls to and from the real object, possibly validating or converting the input from the external world and, thus, protecting the real object.

Unlike multiple inheritance, adaptors can be added at any time to any object (but not removed), which allows for greater flexibility when exporting existing classes. Another advantage of adaptors is to provide similar but not identical functionality in methods of the same name in different interfaces, a case which can be quite common when adding a new version of a standard interface to an object.

In order to use an adaptor, one must create a class which inherits QDBusAbstractAdaptor. Since that is a standard QObject-derived class, the Q_OBJECT macro must appear in the declaration and the source file must be processed with the moc tool. The class must also contain one or more Q_CLASSINFO entries with the "D-Bus Interface" name, declaring which interfaces it is exporting.

Any public slot in the class will be accessible through the bus over messages of the MethodCall type. (See Declaring Slots in D-BUS Adaptors for more information). Signals in the class will be automatically relayed over D-BUS. However, not all types are allowed signals or slots' parameter lists: see The QtDBus Type System for more information.

Also, any property declared with Q_PROPERTY will be automatically exposed over the Properties interface on D-BUS. Since the QObject property system does not allow for non-readable properties, it is not possible to declare write-only properties using adaptors.

More information: