Класс QDBusMessage

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

Этот класс был представлен в Qt 4.2.

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

Общедоступные типы

Общедоступные функции

Статические общедоступные члены

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

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

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

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

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

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

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

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

QDBusMessage::QDBusMessage(const QDBusMessage &other)

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

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

QDBusMessage::QDBusMessage()

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

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

QDBusMessage &QDBusMessage::operator=(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 в контексте «точка-точка» (т.е., не на шине), параметр service является необязательным.

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

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

QDBusMessage QDBusMessage::createReply(const QList<QVariant> &arguments = QList<QVariant>()) 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.

Эта функция была добавлена в 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) перед фактической обработкой метода.

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

Ошибка 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 при вызове метода или генерации сигнала.