Объявление слотов в адаптерах D-Bus

Слоты в адаптерах D-Bus объявляются так же, как обычные публичные слоты, но их параметры должны соответствовать определённым правилам (см. Система типов Qt D-Bus для получения дополнительной информации). Слоты, параметры которых не соответствуют этим правилам или которые не являются публичными, не будут доступны через D-Bus.

Слоты могут иметь один параметр типа const QDBusMessage &, который должен находиться в конце списка входных параметров, перед любыми выходными параметрами. Если этот параметр присутствует, он будет инициализирован копией текущего обрабатываемого сообщения, что позволяет вызываемой функции получить информацию о вызывающей функции, такую как имя её подключения.

Слоты могут быть трёх типов:

1. Асинхронные
2. Только входные
3. Входные и выходные

Асинхронные слоты

Асинхронные слоты — это слоты, которые обычно не возвращают ответа вызывающей функции. По этой причине они не могут принимать выходные параметры. В большинстве случаев к моменту выполнения первой строки кода слота вызывающая функция уже возобновила свою работу.

Однако слоты не должны полагаться на это поведение. Вопросы планирования и обработки сообщений могут изменить порядок выполнения слота. Код, предназначенный для синхронизации с вызывающей функцией, должен обеспечить собственный механизм синхронизации.

Асинхронные слоты отмечаются ключевым словом Q_NOREPLY в сигнатуре метода, перед типом возвращаемого значения void и именем слота. (См. слот quit() в примере адаптера D-Bus ).

Слоты только для ввода

Слоты только для ввода — это обычные слоты, которые принимают параметры, передаваемые по значению или по константной ссылке. Однако, в отличие от асинхронных слотов, вызывающая функция обычно ожидает завершения работы вызываемой функции, прежде чем возобновить свою работу. Поэтому слоты, не являющиеся асинхронными, не должны блокировать или должны указывать в своей документации, что они могут это делать.

Слоты только для ввода не имеют специальной отметки в своей сигнатуре, за исключением того, что они принимают только параметры, передаваемые по значению или по константной ссылке. Дополнительно слоты могут принимать параметр QDBusMessage в качестве последнего параметра, который можно использовать для дополнительного анализа сообщения вызова метода.

Слоты входного и выходного типа

Как и слоты только для ввода, слоты входного и выходного типа — это слоты, для которых вызывающая функция ожидает ответа. В отличие от слотов только для ввода, этот ответ будет содержать данные. Слоты, которые выводят данные, могут содержать неконстантные ссылки и могут также возвращать значение. Однако выходные параметры должны располагаться в конце списка аргументов и не могут иметь входные аргументы, перемежающиеся с ними. Дополнительно, аргумент QDBusMessage может появиться между входными и выходными аргументами.

Автоматические ответы

Ответы на методы генерируются автоматически с содержимым выходных параметров (если таковые имеются) реализацией Qt D-Bus. Слотам не нужно беспокоиться о создании правильных объектов QDBusMessage и отправке их по подключению.

Однако, такая возможность сохраняется. Если слот обнаруживает необходимость отправки специального ответа или даже ошибки, он может сделать это, используя QDBusMessage::createReply() или QDBusMessage::createErrorReply() для параметра QDBusMessage и отправить его с помощью QDBusConnection::send(). Реализация Qt D-Bus не будет генерировать ответ, если слот сделал это.

Предупреждение: Когда вызывающая функция размещает вызов метода и ожидает ответа, она будет ждать только ограниченное время. Слоты, предполагающие длительное выполнение, должны четко указывать этот факт в документации, чтобы вызывающие функции могли правильно установить более длительные таймауты.

Отложенные ответы

В некоторых случаях вызываемый слот может не иметь возможности немедленно обработать запрос. Это часто происходит, когда запрос включает операцию ввода-вывода или сетевую операцию, которая может заблокироваться.

В этом случае слот должен вернуть управление обратно главному циклу приложения, чтобы избежать зависания пользовательского интерфейса, и продолжить процесс позднее. Для этого он должен использовать дополнительный параметр QDBusMessage в конце списка входных параметров и запросить отложенный ответ.

Это делается путём написания слота, который хранит данные запроса в постоянной структуре, указывая вызывающей функции с помощью QDBusMessage::setDelayedReply(true), что ответ будет отправлен позже.

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

Использование QDBusConnection::sessionBus().send(data->reply) необходимо для явного уведомления вызывающей функции о том, что ответ будет отложен. В этом случае возвращаемое значение не имеет значения; мы возвращаем произвольное значение для удовлетворения компилятора.

При обработке запроса и наличии ответа его следует отправить, используя объект QDBusMessage, который был получен. В нашем примере код ответа может быть следующим:

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

Как видно из примера, при наличии отложенного ответа возвращаемое значение(я) слота будут проигнорированы Qt D-Bus. Они используются только для определения сигнатуры слота при передаче описания адаптера удалённым приложениям или в случае, если код в слоте решит не использовать отложенный ответ.

Сам отложенный ответ запрашивается у Qt D-Bus вызовом QDBusMessage::reply() на исходное сообщение. Затем ответственность за отправку ответа вызывающей функции ложится на код вызываемой функции.

Предупреждение: Когда вызывающая функция размещает вызов метода и ожидает ответа, она будет ждать только ограниченное время. Слоты, предполагающие длительное выполнение, должны четко указывать этот факт в документации, чтобы вызывающие функции могли правильно установить более длительные таймауты.

См. также Использование адаптеров Qt D-Bus, Объявление сигналов в адаптерах D-Bus, Система типов Qt D-Bus, QDBusConnection и QDBusMessage.