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

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

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

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

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

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

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

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

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

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

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

Для слотов только для ввода нет специальных пометок в сигнатуре, за исключением того, что они принимают только параметры, передаваемые по значению или по константной ссылке. Дополнительно, слоты могут принимать параметр 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();

    appendRequest(data);
    return QString();
}

В этом случае возвращаемое значение не имеет значения; мы возвращаем произвольное значение для удовлетворения компилятора.

Когда запрос обработан и ответ доступен, его необходимо отправить, используя объект 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.