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