Qt 4.8: Declaring Slots in D-Bus Adaptors

Qt Reference Documentation

Declaring Signals in D-Bus Adaptors

# Declaring Slots in D-Bus Adaptors

Slots in D-Bus adaptors are declared just like normal, public slots, but their parameters must follow certain rules (see The QtDBus Type System for more information). Slots whose parameters do not follow those rules or that are not public will not be accessible via D-Bus.

Slots can have one parameter of type `const QDBusMessage &`, which must appear at the end of the input parameter list, before any output parameters. This parameter, if present, will be initialized with a copy of the current message being processed, which allows the callee to obtain information about the caller, such as its connection name.

Slots can be of three kinds:

1. Asynchronous
2. Input-only
3. Input-and-output

## Asynchronous Slots

Asynchronous slots are those that do not normally return any reply to the caller. For that reason, they cannot take any output parameters. In most cases, by the time the first line of the slot is run, the caller function has already resumed working.

However, slots must not rely on that behavior. Scheduling and message-dispatching issues could change the order in which the slot is run. Code intending to synchronize with the caller should provide its own method of synchronization.

Asynchronous slots are marked by the keyword Q_NOREPLY in the method signature, before the `void` return type and the slot name. (See the `quit()` slot in the D-Bus Adaptor Example).

## Input-Only Slots

Input-only slots are normal slots that take parameters passed by value or by constant reference. However, unlike asynchronous slots, the caller is usually waiting for completion of the callee before resuming operation. Therefore, non-asynchronous slots should not block or should state it its documentation that they may do so.

Input-only slots have no special marking in their signature, except that they take only parameters passed by value or by constant reference. Optionally, slots can take a QDBusMessage parameter as a last parameter, which can be used to perform additional analysis of the method call message.

## Input and Output Slots

Like input-only slots, input-and-output slots are those that the caller is waiting for a reply. Unlike input-only ones, though, this reply will contain data. Slots that output data may contain non-constant references and may return a value as well. However, the output parameters must all appear at the end of the argument list and may not have input arguments interleaved. Optionally, a QDBusMessage argument may appear between the input and the output arguments.

## Automatic Replies

Method replies are generated automatically with the contents of the output parameters (if there were any) by the QtDBus implementation. Slots need not worry about constructing proper QDBusMessage objects and sending them over the connection.

However, the possibility of doing so remains there. Should the slot find out it needs to send a special reply or even an error, it can do so by using QDBusMessage::createReply() or QDBusMessage::createErrorReply() on the QDBusMessage parameter and send it with QDBusConnection::send(). The QtDBus implementation will not generate any reply if the slot did so.

Warning: When a caller places a method call and waits for a reply, it will only wait for a limited amount of time. Slots intending to take a long time to complete should make that fact clear in documentation so that callers properly set higher timeouts.

## Delayed Replies

In some circumstances, the called slot may not be able to process the request immediately. This is frequently the case when the request involves an I/O or networking operation which may block.

If this is the case, the slot should return control to the application's main loop to avoid freezing the user interface, and resume the process later. To accomplish this, it should make use of the extra `QDBusMessage` parameter at the end of the input parameter list and request a delayed reply.

We do this by writing a slot that stores the request data in a persistent structure, indicating to the caller using QDBusMessage::setDelayedReply(true) that the response will be sent later.

     struct RequestData
     {
         QString request;
         QString processedData;
         QDBusMessage reply;
     };

     QString processRequest(const QString &request, const QDBusMessage &message)
     {
         RequestData *data = new RequestData;
         data->request = request;
         message.setDelayedReply(true);
         data->reply = message.createReply();
         QDBusConnection::sessionBus().send(data->reply);

         appendRequest(data);
         return QString();
     }

The use of QDBusConnection::sessionBus().send(data->reply) is needed to explicitly inform the caller that the response will be delayed. In this case, the return value is unimportant; we return an arbitrary value to satisfy the compiler.

When the request is processed and a reply is available, it should be sent using the `QDBusMessage` object that was obtained. In our example, the reply code could be something as follows:

     void sendReply(RequestData *data)
     {
         // data->processedData has been initialized with the request's reply
         QDBusMessage &reply = &data->reply;

         // send the reply over D-Bus:
         reply << data->processedData;
         QDBusConnection::sessionBus().send(reply);

         // dispose of the transaction data
         delete data;
     }

As can be seen in the example, when a delayed reply is in place, the return value(s) from the slot will be ignored by QtDBus. They are used only to determine the slot's signature when communicating the adaptor's description to remote applications, or in case the code in the slot decides not to use a delayed reply.

The delayed reply itself is requested from QtDBus by calling QDBusMessage::reply() on the original message. It then becomes the resposibility of the called code to eventually send a reply to the caller.

Warning: When a caller places a method call and waits for a reply, it will only wait for a limited amount of time. Slots intending to take a long time to complete should make that fact clear in documentation so that callers properly set higher timeouts.

See also Using QtDBus Adaptors, Declaring Signals in D-Bus Adaptors, The QtDBus Type System, QDBusConnection, and QDBusMessage.

Declaring Signals in D-Bus Adaptors