Development/Tutorials/D-Bus/Accessing Interfaces

< Development‎ | Tutorials‎ | D-Bus
Revision as of 04:10, 1 January 2007 by Aseigo (Talk | contribs)

Jump to: navigation, search

Contents

Abstract

D-Bus allows applications to expose internal API to the outside world. These APIs can then be accessed at run-time via the D-Bus protocol using command line applications or D-Bus libraries and bindings themselves. This tutorial looks at the latter method with examples that you can use in your applications.

Prerequisites

Technologies:

  • Qt4
  • D-Bus


Tutorials:

D-Bus Interfaces

Using QDBusMessage

QDBusMessage represents a D-BUS messages that can be sent or has been received over a given bus. It can be used directly to call methods in D-BUS services using the QDbusMessage::createMethod( const QString & service, const QString & path, const QString & interface, const QString & method ) static method. It returns a QDBusMessage object that you can then use to make the call.

The interface parameter is optional and only necessary if the method to be called is not unique in the accessed object address by the path. This can happen with the object implements multiple interfaces and those interfaces have methods with the same name. In such (rare) cases, if you do not define the interface to use there is not guarantee as to which method will actually get called. However, usually you can simply pass an empty string (e.g. "") as the argument for interface.


By way of example, to access the (fictional) ping method on the /network object in the org.foo.bar service, one might do this:

QDBusMessage* m = QDBusMessage::createMessage("org.foo.bar",

                                            "/network",
                                            "",
                                            "ping");

bool queued = QDBusConnection::sessionBus()->send(m);

In line 5 of the above example we queue the message for sending on the current session bus. We get a bool returned letting us know if the queuing was successful or not.

This leaves us with two questions, however:

  • How can one set parameters for a method call?
  • How can one get a return message in the case of D-Bus methods that have a return value?

Setting Parameters

Sending arguments along with the method call is quite straight forward. First we need to create a QList of QVariant objects and then add those to our dbus message. So if the ping method in the above took a hostname as a parameter, we might alter the code in this way:

QDBusMessage* m = QDBusMessage::createMessage("org.foo.bar",

                                            "/network",
                                            "",
                                            "ping");

QList<QVariant> args; args.append("kde.org"); m->setArguments(args); bool queued = QDBusConnection::sessionBus()->send(m);

noframe
 
Note
The arguments must appear in the QList in the same order they are expected by the D-Bus method being called.

Using QDBusInterface

Using An Interface

Connecting To Signals

Other Resources


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal