Development/Tutorials/D-Bus/Accessing Interfaces

Accessing D-Bus Interfaces

Tutorial Series	D-Bus
Previous	Introduction To D-Bus
What's Next	Creating D-Bus Interfaces
Further Reading	n/a

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.

Using QDBusMessage

QDBusMessage represents a D-Bus messages that can be sent or has been received over a given bus. Each message is one of five types, depending on the purpose of the message:

• method call
• signal
• reply
• error
• invalid

An enumeration covering each of these possibilities is defined in QDBusMessage. A message's type can be access via the QDBusMessage::type() method.

Calling a D-Bus Method

A QDBusMessage 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 (note lines 5 through 7):

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);

Note

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

Getting Replies

If we wish to actually receive information back from the D-Bus method, we use the QDBusConnect::call method instead. It will block until there is a reply or the call times out. If our ping method returned information on the host we provided in the arguments above, we might alter our code to look like this:

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

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

QList<QVariant> args; args.append("kde.org"); m.setArguments(args); QDBusMessage response = QDBusConnection::sessionBus()->call(m);

The response will be either of type QDBusMessage::ReplyMessage or QDBusMessage::ErrorMessage depending on whether it was successful or not. We can look through the values returned by retreving the arguments with the QDBusMessage::arguments() method which returns a QList<QVariant>.

Is This The Best Way?

Using QDBusMessage directly in this way to invoke remote D-Bus methods is not the easiest, best or even recommend way of doing things. Next we will look at the more convnient QDBusInterface class and then look at accessing remote D-Bus interfaces as if they were local methods using a class auto-generated from the XML D-Bus interface description.

Using QDBusInterface

QDBusInterface provides a simple and direct method to make D-Bus calls and connect to D-Bus signals.

A QDBusInterface object represents a given D-Bus interface. The constructor accepts as parameters (in order) a service name, an object path, an optional interface and optionally which bus (e.g. system or session) to use. If no bus is explicitly define, it defaults to the session bus.

As QDBusInterface is a QObject, you can also pass it a parent object. This helps simplify the bookkeeping associated with creating new QDBusInterface objects by letting Qt clean up for you when the parent object is deleted.

Here is an example of QDBusInterface usage which we will then step through line by line:

QString hostname("kde.org"); QDBusInterface interface = new QDBusInterface("org.foo.bar", "/network",

                                             QString(), 
                                             QDBusConnection::sessionBus(),
                                             this); 

interface->call("ping"); interface->call("ping", hostname);

QDBusReply<int> reply = interface->call("ping", hostname); if (reply.isValid()) {

    KMessageBox::information(winId(), 
                             i18n("Ping response time to %1 was %2")
                             .arg(hostname).arg(reply.value()),
                             i18n("Pinging %1").arg(hostname));

}

QList<QVariant> args; args.append("kde.org"); interface->callWithArgumentList("ping", args);

args.clear(); interface->callWithCallback("listInterfaces", args,

                           this, SLOT(interfaceList(QDBusReply));

connect(interface, SIGNAL(interfaceUp(QString)),

       this, SLOT(interfaceUp(QString)));