Объявление слотов в адаптерах 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();
    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.