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

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

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

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

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

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

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

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

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

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

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

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