Объявление слотов в 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.