QDBusMessage Class
La clase `QDBusMessage` representa un mensaje enviado o recibido a través del bus D-Bus. Más información...
| Encabezado: | #include <QDBusMessage> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS DBus) target_link_libraries(mytarget PRIVATE Qt6::DBus) |
| qmake: | QT += dbus |
Tipos públicos
| enum | MessageType { MethodCallMessage, SignalMessage, ReplyMessage, ErrorMessage, InvalidMessage } |
Funciones públicas
| QDBusMessage() | |
| QDBusMessage(const QDBusMessage &other) | |
(since 6.11) | QDBusMessage(QDBusMessage &&other) |
| ~QDBusMessage() | |
| QList<QVariant> | arguments() const |
| bool | autoStartService() const |
| QDBusMessage | createErrorReply(const QDBusError &error) const |
| QDBusMessage | createErrorReply(QDBusError::ErrorType type, const QString &msg) const |
| QDBusMessage | createErrorReply(const QString &name, const QString &msg) const |
| QDBusMessage | createReply(const QList<QVariant> &arguments = QList<QVariant>()) const |
| QDBusMessage | createReply(const QVariant &argument) const |
| QString | errorMessage() const |
| QString | errorName() const |
| QString | interface() const |
| bool | isDelayedReply() const |
| bool | isInteractiveAuthorizationAllowed() const |
| bool | isReplyRequired() const |
| QString | member() const |
| QString | path() const |
| QString | service() const |
| void | setArguments(const QList<QVariant> &arguments) |
| void | setAutoStartService(bool enable) |
| void | setDelayedReply(bool enable) const |
| void | setInteractiveAuthorizationAllowed(bool enable) |
| QString | signature() const |
| void | swap(QDBusMessage &other) |
| QDBusMessage::MessageType | type() const |
| QDBusMessage & | operator<<(const QVariant &arg) |
| QDBusMessage & | operator=(QDBusMessage &&other) |
| QDBusMessage & | operator=(const QDBusMessage &other) |
Miembros públicos estáticos
| QDBusMessage | createError(const QDBusError &error) |
| QDBusMessage | createError(QDBusError::ErrorType type, const QString &msg) |
| QDBusMessage | createError(const QString &name, const QString &msg) |
| QDBusMessage | createMethodCall(const QString &service, const QString &path, const QString &interface, const QString &method) |
| QDBusMessage | createSignal(const QString &path, const QString &interface, const QString &name) |
| QDBusMessage | createTargetedSignal(const QString &service, const QString &path, const QString &interface, const QString &name) |
Descripción detallada
Este objeto puede representar cualquiera de los cuatro tipos diferentes de mensajes (MessageType) que pueden producirse en el bus:
- Llamadas a métodos
- Valores de retorno de métodos
- Emisiones de señales
- Códigos de error
Los objetos de este tipo se crean con las funciones estáticas createError(), createMethodCall() y createSignal(). Utiliza la función QDBusConnection::send() para enviar los mensajes.
Documentación sobre tipos de miembros
enum QDBusMessage::MessageType
Los posibles tipos de mensajes:
| Constante | Valor | Descripción |
|---|---|---|
QDBusMessage::MethodCallMessage | 1 | un mensaje que representa una llamada a un método saliente o entrante |
QDBusMessage::SignalMessage | 4 | un mensaje que representa la emisión de una señal saliente o entrante |
QDBusMessage::ReplyMessage | 2 | un mensaje que representa los valores de retorno de una llamada a un método |
QDBusMessage::ErrorMessage | 3 | un mensaje que representa una condición de error en respuesta a una llamada a un método |
QDBusMessage::InvalidMessage | 0 | un mensaje no válido: esto nunca se establece en los mensajes recibidos de D-Bus |
Documentación de las funciones de miembro
QDBusMessage::QDBusMessage()
Crea un objeto `QDBusMessage` vacío y no válido.
Véase también createError(), createMethodCall() y createSignal().
QDBusMessage::QDBusMessage(const QDBusMessage &other)
Crea una copia del objeto proporcionado por ` other`.
Nota: Los objetos `QDBusMessage` son compartidos. Las modificaciones realizadas en la copia afectarán también al original. Consulte ` setDelayedReply()` para obtener más información.
[noexcept, since 6.11] QDBusMessage::QDBusMessage(QDBusMessage &&other)
Traslada other a este objeto.
Nota: El objeto del que se ha realizado la transferencia, other, queda en un estado parcialmente formado, en el que las únicas operaciones válidas son la destrucción y la asignación de un nuevo valor.
Esta función se introdujo en Qt 6.11.
[noexcept] QDBusMessage::~QDBusMessage()
Elimina el objeto y libera los recursos que tenía ocupados.
QList<QVariant> QDBusMessage::arguments() const
Devuelve la lista de argumentos que se van a enviar o que se han recibido de D-Bus.
Véase también setArguments().
bool QDBusMessage::autoStartService() const
Devuelve el indicador de inicio automático, tal y como se establece mediante la función setAutoStartService(). Por defecto, este indicador es «true», lo que significa que Qt D-Bus iniciará automáticamente un servicio si aún no se está ejecutando.
Véase también setAutoStartService().
[static] QDBusMessage QDBusMessage::createError(const QDBusError &error)
Crea un nuevo mensaje DBus que representa el objeto « error » especificado.
[static] QDBusMessage QDBusMessage::createError(QDBusError::ErrorType type, const QString &msg)
Crea un nuevo mensaje DBus para el tipo de error « type » utilizando el mensaje « msg ». Devuelve el mensaje DBus.
[static] QDBusMessage QDBusMessage::createError(const QString &name, const QString &msg)
Crea un nuevo mensaje DBus que representa un error, con los valores indicados para « name » y « msg ».
QDBusMessage QDBusMessage::createErrorReply(const QDBusError &error) const
Crea un nuevo mensaje DBus que representa un mensaje de respuesta de error, a partir del objeto ` error ` proporcionado.
QDBusMessage QDBusMessage::createErrorReply(QDBusError::ErrorType type, const QString &msg) const
Crea un nuevo mensaje de respuesta DBus para el tipo de error « type » utilizando el mensaje « msg ». Devuelve el mensaje DBus.
QDBusMessage QDBusMessage::createErrorReply(const QString &name, const QString &msg) const
Crea un nuevo mensaje DBus que representa un mensaje de respuesta de error, con los valores proporcionados para « name » y « msg ».
[static] QDBusMessage QDBusMessage::createMethodCall(const QString &service, const QString &path, const QString &interface, const QString &method)
Crea un nuevo mensaje DBus que representa una llamada a un método. Una llamada a un método siempre indica su dirección de destino (service, path, interface y method).
El bus DBus permite llamar a un método de un objeto remoto determinado sin especificar la interfaz de destino, siempre que el nombre del método sea único. Sin embargo, si dos interfaces del objeto remoto exportan el mismo nombre de método, el resultado es indefinido (puede que se llame a una de las dos o que se devuelva un error).
Cuando se utiliza DBus en un contexto de igual a igual (es decir, no en un bus), el parámetro service es opcional.
La clase ` QDBusInterface ` proporciona una abstracción más sencilla para la llamada síncrona a métodos.
Esta función devuelve un objeto ` QDBusMessage ` que puede enviarse con ` QDBusConnection::call()`.
QDBusMessage QDBusMessage::createReply(const QList<QVariant> &arguments = QList<QVariant>()) const
Crea un nuevo mensaje DBus que representa una respuesta, con el valor dado de ` arguments`.
QDBusMessage QDBusMessage::createReply(const QVariant &argument) const
Crea un nuevo mensaje DBus que representa una respuesta, con el ` argument` indicado.
[static] QDBusMessage QDBusMessage::createSignal(const QString &path, const QString &interface, const QString &name)
Crea un nuevo mensaje DBus con los valores proporcionados de « path », « interface » y « name », lo que representa la emisión de una señal.
Una señal DBus es emitida por una aplicación y la reciben todas las aplicaciones que están a la escucha de dicha señal desde esa interfaz.
El objeto ` QDBusMessage ` que se devuelve puede enviarse mediante la función ` QDBusConnection::send()`.
[static] QDBusMessage QDBusMessage::createTargetedSignal(const QString &service, const QString &path, const QString &interface, const QString &name)
Crea un nuevo mensaje DBus con los valores proporcionados para « path », « interface » y « name », lo que representa el envío de una señal a un destino específico.
Una señal DBus es emitida desde una aplicación y solo la recibe la aplicación propietaria del nombre de destino service.
El objeto QDBusMessage devuelto puede enviarse mediante la función QDBusConnection::send().
QString QDBusMessage::errorMessage() const
Devuelve el mensaje legible para el usuario asociado al error que se ha recibido.
QString QDBusMessage::errorName() const
Devuelve el nombre del error que se ha producido.
QString QDBusMessage::interface() const
Devuelve la interfaz del método que se está llamando (en el caso de una llamada a un método) o de la señal que se está recibiendo.
bool QDBusMessage::isDelayedReply() const
Devuelve el indicador de respuesta diferida, tal y como se establece mediante la función ` setDelayedReply()`. Por defecto, este indicador es `false`, lo que significa que ` Qt D-Bus ` generará respuestas automáticas cuando sea necesario.
bool QDBusMessage::isInteractiveAuthorizationAllowed() const
Devuelve si el mensaje tiene activado el indicador « ALLOW_INTERACTIVE_AUTHORIZATION ».
Véase también ` setInteractiveAuthorizationAllowed()` y ` QDBusAbstractInterface::isInteractiveAuthorizationAllowed()`.
bool QDBusMessage::isReplyRequired() const
Devuelve el indicador que señala si este mensaje debe recibir una respuesta o no. Esto solo tiene sentido para los mensajes de tipo « method call messages »: cualquier otro tipo de mensaje no puede recibir respuestas y esta función siempre devolverá «false» para ellos.
QString QDBusMessage::member() const
Devuelve el nombre de la señal que se ha emitido o el nombre del método que se ha llamado.
QString QDBusMessage::path() const
Devuelve la ruta del objeto al que se envía este mensaje (en el caso de una llamada a un método) o del que se recibe (en el caso de una señal).
QString QDBusMessage::service() const
Devuelve el nombre del servicio o la dirección del bus de la llamada a un método remoto.
void QDBusMessage::setArguments(const QList<QVariant> &arguments)
Establece los argumentos que se van a enviar a través de D-Bus a arguments. Estos serán los argumentos de una llamada a un método o los parámetros de la señal.
Ten en cuenta que no se permite en ` arguments` un ` QVariantMap ` con un valor ` QVariant ` no válido.
Véase también arguments().
void QDBusMessage::setAutoStartService(bool enable)
Establece el indicador de inicio automático en « enable ». Este indicador solo tiene sentido en los mensajes de llamada a métodos, donde indica al servidor D-Bus que inicie automáticamente el servicio responsable del nombre del servicio, o que no lo inicie automáticamente.
Por defecto, este indicador es «true», es decir, el servicio se inicia automáticamente. Esto significa que:
Cuando el servicio al que se envía esta llamada de método ya se está ejecutando, la llamada de método se le envía a él. Si el servicio aún no se está ejecutando, se solicita al demonio de D-Bus que inicie automáticamente el servicio asignado a ese nombre de servicio. Esto se gestiona mediante archivos .service ubicados en un directorio conocido por el servidor de D-Bus. Cada uno de estos archivos contiene un nombre de servicio y la ruta a un programa que debe ejecutarse cuando se solicite dicho nombre de servicio.
Véase también autoStartService().
void QDBusMessage::setDelayedReply(bool enable) const
Establece si se responderá al mensaje más tarde (si enable es verdadero) o si se debe generar una respuesta automática mediante Qt D-Bus (si enable es falso).
En D-Bus, todas las llamadas a métodos deben generar una respuesta al llamante, a menos que este indique explícitamente lo contrario (véase isReplyRequired()). QtDBus genera automáticamente dichas respuestas para cualquier slot que se llame, pero también permite que los slots indiquen si se encargarán de enviar la respuesta más tarde, una vez que la función haya terminado de procesarse.
Véase también isDelayedReply() y Respuestas diferidas.
void QDBusMessage::setInteractiveAuthorizationAllowed(bool enable)
Activa o desactiva el indicador « ALLOW_INTERACTIVE_AUTHORIZATION » en un mensaje.
Este indicador solo tiene sentido en los mensajes de llamada a métodos (QDBusMessage::MethodCallMessage). Si enable se establece en true, el indicador señala al destinatario que el autor de la llamada al método está dispuesto a esperar a que se produzca una autorización interactiva (por ejemplo, a través de Polkit) antes de que se procese el método propiamente dicho.
Si enable se establece en false, el indicador no se activa, lo que significa que se espera que la otra parte tome cualquier decisión de autorización de forma no interactiva y con prontitud. Este es el valor por defecto.
El error org.freedesktop.DBus.Error.InteractiveAuthorizationRequired indica que la autorización ha fallado, pero podría haber tenido éxito si se hubiera activado este indicador.
Véase también isInteractiveAuthorizationAllowed() y QDBusAbstractInterface::setInteractiveAuthorizationAllowed().
QString QDBusMessage::signature() const
Devuelve la firma de la señal recibida o, en el caso de los argumentos de salida, de una llamada a un método.
[noexcept] void QDBusMessage::swap(QDBusMessage &other)
Intercambia este mensaje con other. Esta operación es muy rápida y nunca falla.
QDBusMessage::MessageType QDBusMessage::type() const
Devuelve el tipo de mensaje.
QDBusMessage &QDBusMessage::operator<<(const QVariant &arg)
Añade el argumento « arg » a la lista de argumentos que se enviarán a través de D-Bus en una llamada a un método o en la emisión de una señal.
[noexcept] QDBusMessage &QDBusMessage::operator=(QDBusMessage &&other)
La operación «move-assign» asigna other a este objeto.
Nota: El objeto del que se ha realizado el traslado, other, queda en un estado parcialmente formado, en el que las únicas operaciones válidas son la destrucción y la asignación de un nuevo valor.
QDBusMessage &QDBusMessage::operator=(const QDBusMessage &other)
Copia el contenido del objeto especificado mediante ` other`.
Nota: Los objetos ` QDBusMessage ` son compartidos. Las modificaciones realizadas en la copia afectarán también al original. Consulta ` setDelayedReply()` para obtener más información.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.