Класс QDBusMessage

Класс QDBusMessage представляет собой одно сообщение, отправленное или полученное по шине D-Bus. Подробнее...

• Список всех членов, включая унаследованные

Типы public

Функции public

Статические public члены

Подробное описание

Класс QDBusMessage представляет собой одно сообщение, отправленное или полученное по шине D-Bus.

Этот объект может представлять любой из четырёх различных типов сообщений (MessageType), которые могут возникать на шине:

• Вызовы методов
• Возвращаемые значения методов
• Выбросы сигналов
• Коды ошибок

Объекты этого типа создаются с помощью статических функций createError(), createMethodCall() и createSignal(). Используйте функцию QDBusConnection::send() для отправки сообщений.

Документация по типам членов

перечисление QDBusMessage::MessageType

Возможные типы сообщений:

Документация по функциям-членам

QDBusMessage::QDBusMessage()

Конструирует пустой, недействительный объект QDBusMessage.

См. также createError(), createMethodCall() и createSignal().

QDBusMessage::QDBusMessage(const QDBusMessage &other)

Конструирует копию объекта, заданного other.

Примечание: объекты QDBusMessage совместно используются. Изменения, внесённые в копию, также повлияют на оригинальный объект. См. setDelayedReply() для получения дополнительной информации.

QDBusMessage::~QDBusMessage()

Удаляет объект и освобождает все занимаемые ресурсы.

QList<QVariant> QDBusMessage::arguments() const

Возвращает список аргументов, которые будут отправлены или были получены от D-Bus.

См. также setArguments().

bool QDBusMessage::autoStartService() const

Возвращает флаг автоматического запуска, установленный функцией setAutoStartService(). По умолчанию этот флаг равен true, что означает, что Qt D-Bus автоматически запустит службу, если она ещё не запущена.

Данная функция была добавлена в Qt 4.7.

См. также setAutoStartService().

[static] QDBusMessage QDBusMessage::createError(const QString &name, const QString &msg)

Создаёт новый DBus-сообщение, представляющее ошибку с заданным значением name и msg.

[static] QDBusMessage QDBusMessage::createError(const QDBusError &error)

Создаёт новое DBus-сообщение, представляющее заданную ошибку error.

[static] QDBusMessage QDBusMessage::createError(QDBusError::ErrorType type, const QString &msg)

Создаёт новое DBus-сообщение для типа ошибки type, используя сообщение msg. Возвращает DBus-сообщение.

QDBusMessage QDBusMessage::createErrorReply(const QString name, const QString &msg) const

Создаёт новое DBus-сообщение, представляющее ответ с ошибкой, с заданным значением name и msg.

QDBusMessage QDBusMessage::createErrorReply(const QDBusError &error) const

Создаёт новое DBus-сообщение, представляющее ответ с ошибкой, по заданному объекту error.

QDBusMessage QDBusMessage::createErrorReply(QDBusError::ErrorType type, const QString &msg) const

Создаёт новый DBus-ответ с ошибкой для типа type, используя сообщение msg. Возвращает DBus-сообщение.

[static] QDBusMessage QDBusMessage::createMethodCall(const QString &service, const QString &path, const QString &interface, const QString &method)

Создаёт новое DBus-сообщение, представляющее вызов метода. Вызов метода всегда указывает адрес назначения (service, path, interface и method).

DBus-шина позволяет вызывать метод на заданном удалённом объекте без указания целевого интерфейса, если имя метода уникально. Однако, если два интерфейса на удалённом объекте экспортируют метод с одинаковым именем, результат неопределён (может быть вызван один из них или возвращена ошибка).

При использовании DBus в контексте peer-to-peer (т.е. не на шине), параметр service является необязательным.

Класс QDBusInterface предоставляет более простое абстрагирование для синхронных вызовов методов.

Эта функция возвращает объект QDBusMessage, который можно отправить с помощью QDBusConnection::call().

QDBusMessage QDBusMessage::createReply(const QList<QVariant> &arguments = ...) const

Создаёт новое DBus-сообщение, представляющее ответ с заданными arguments.

QDBusMessage QDBusMessage::createReply(const QVariant &argument) const

Создаёт новое DBus-сообщение, представляющее ответ с заданным аргументом argument.

[static] QDBusMessage QDBusMessage::createSignal(const QString &path, const QString &interface, const QString &name)

Создаёт новое DBus-сообщение с заданным path, interface и name, представляющее отправку сигнала.

DBus-сигнал испускается одним приложением и принимается всеми приложениями, которые следят за этим сигналом от этого интерфейса.

Возвращаемый объект QDBusMessage может быть отправлен с помощью функции QDBusConnection::send().

[static] QDBusMessage QDBusMessage::createTargetedSignal(const QString &service, const QString &path, const QString &interface, const QString &name)

Создаёт новое DBus-сообщение с заданным path, interface и name, представляющее отправку сигнала определённому получателю.

DBus-сигнал испускается одним приложением и принимается только приложением, владеющим целевым именем service.

Возвращаемый объект QDBusMessage может быть отправлен с помощью функции QDBusConnection::send().

Данная функция была добавлена в Qt 5.6.

QString QDBusMessage::errorMessage() const

Возвращает удобочитаемое сообщение, связанное с полученной ошибкой.

Данная функция была добавлена в Qt 4.3.

QString QDBusMessage::errorName() const

Возвращает имя полученной ошибки.

QString QDBusMessage::interface() const

Возвращает интерфейс вызываемого метода (в случае вызова метода) или интерфейс полученного сигнала.

bool QDBusMessage::isDelayedReply() const

Возвращает флаг отложенного ответа, установленный функцией setDelayedReply(). По умолчанию этот флаг равен false, что означает, что Qt D-Bus будет генерировать автоматические ответы при необходимости.

bool QDBusMessage::isInteractiveAuthorizationAllowed() const

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

Данная функция была добавлена в Qt 5.12.

См. также setInteractiveAuthorizationAllowed().

bool QDBusMessage::isReplyRequired() const

Возвращает флаг, указывающий, требуется ли ответ на это сообщение. Это имеет смысл только для сообщений вызова метода: любые другие типы сообщений не могут иметь ответы, и эта функция всегда вернёт false для них.

QString QDBusMessage::member() const

Возвращает имя сигнала, который был отправлен, или имя метода, который был вызван.

QString QDBusMessage::path() const

Возвращает путь к объекту, которому отправляется это сообщение (в случае вызова метода) или от которого оно получено (для сигнала).

QString QDBusMessage::service() const

Возвращает имя службы или адрес шины удалённого вызова метода.

void QDBusMessage::setArguments(const QList<QVariant> &arguments)

Устанавливает аргументы, которые будут отправлены по D-Bus, в arguments. Это будут аргументы вызова метода или параметры в сигнале.

См. также arguments().

void QDBusMessage::setAutoStartService(bool enable)

Устанавливает флаг автоматического запуска в enable. Этот флаг имеет смысл только для сообщений вызова метода, где он сообщает серверу D-Bus, следует ли автоматически запускать службу, отвечающую за имя службы, или нет.

По умолчанию этот флаг равен true, т.е. служба запускается автоматически. Это означает:

Если служба, которому отправляется вызов метода, уже запущена, вызов метода отправляется ей. Если служба ещё не запущена, от демона D-Bus запрашивается автоматический запуск службы, назначенной этому имени службы. Это обрабатывается файлами .service, которые размещаются в каталоге, известном серверу D-Bus. Эти файлы затем содержат имя службы и путь к программе, которая должна быть запущена, когда запрашивается это имя службы.

Данная функция была введена в Qt 4.7.

См. также autoStartService().

void QDBusMessage::setDelayedReply(bool enable) const

Устанавливает, будет ли сообщение отвечать позже (если enable истинно) или Qt D-Bus сгенерирует автоматический ответ (если enable ложно).

В D-Bus все вызовы методов должны генерировать ответ вызывающей стороне, если вызывающая сторона не указывает обратное (см. isReplyRequired()). QtDBus автоматически генерирует такие ответы для вызываемых слотов, но также позволяет слотам указывать, будут ли они отвечать позже, после завершения обработки функции.

См. также isDelayedReply() и Отложенные ответы.

void QDBusMessage::setInteractiveAuthorizationAllowed(bool enable)

Устанавливает флаг интерактивного авторизованного доступа в значение enable. Этот флаг имеет смысл только для сообщений вызовов методов, где он сообщает серверу D-Bus, что вызывающая сторона готова ждать интерактивной авторизации (например, через Polkit) перед фактической обработкой метода.

По умолчанию этот флаг равен false, и ожидается, что другая сторона примет решения об авторизации без участия пользователя и немедленно.

Ошибка org.freedesktop.DBus.Error.InteractiveAuthorizationRequired указывает на то, что авторизация не удалась, но могла бы быть успешной, если бы был установлен этот флаг.

Данная функция была введена в Qt 5.12.

См. также isInteractiveAuthorizationAllowed().

QString QDBusMessage::signature() const

Возвращает сигнатуру полученного сигнала или выходных аргументов вызова метода.

void QDBusMessage::swap(QDBusMessage &other)

Меняет местами этот экземпляр QDBusMessage и other.

QDBusMessage::MessageType QDBusMessage::type() const

Возвращает тип сообщения.

QDBusMessage &QDBusMessage::operator<<(const QVariant &arg)

Добавляет аргумент arg в список аргументов, которые будут отправлены по D-Bus при вызове метода или генерации сигнала.

QDBusMessage &QDBusMessage::operator=(QDBusMessage &&other)

Оператор перемещающего присваивания.

QDBusMessage &QDBusMessage::operator=(const QDBusMessage &other)

Копирует содержимое объекта, заданного other.

Примечание: объекты QDBusMessage разделяются. Изменения, внесенные в копию, повлияют и на оригинальный объект. См. setDelayedReply() для получения дополнительной информации.