QDBusContext Class
La clase `QDBusContext` permite a las ranuras determinar el contexto D-Bus de las llamadas. Más información...
| Encabezado: | #include <QDBusContext> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS DBus) target_link_libraries(mytarget PRIVATE Qt6::DBus) |
| qmake: | QT += dbus |
Funciones públicas
| QDBusContext() | |
| ~QDBusContext() | |
| bool | calledFromDBus() const |
| QDBusConnection | connection() const |
| bool | isDelayedReply() const |
| const QDBusMessage & | message() const |
| void | sendErrorReply(const QString &name, const QString &msg = QString()) const |
| void | sendErrorReply(QDBusError::ErrorType type, const QString &msg = QString()) const |
| void | setDelayedReply(bool enable) const |
Descripción detallada
Cuando se invoca una ranura en un objeto debido a la entrega de una señal o a una llamada a un método remoto, a veces es necesario conocer el contexto en el que se ha producido dicha invocación. En concreto, si la ranura decide que quiere enviar la respuesta más adelante o si quiere responder con un error, se necesita conocer el contexto.
La clase `QDBusContext` es una alternativa para acceder al contexto que no implica modificar el código generado por el compilador XML de `Qt D-Bus ` (qdbusxml2cpp).
QDBusContext se utiliza creando una subclase a partir de los objetos que se exportan mediante QDBusConnection::registerObject(). El siguiente ejemplo ilustra su uso:
class MyObject: public QObject,
protected QDBusContext
{
Q_OBJECT
QDBusConnection conn;
QDBusMessage msg;
//...
protected slots:
void process();
public slots:
void methodWithError();
QString methodWithDelayedReply();
};
void MyObject::methodWithError()
{
sendErrorReply(QDBusError::NotSupported,
"The method call 'methodWithError()' is not supported");
}
QString MyObject::methodWithDelayedReply()
{
conn = connection();
msg = message();
setDelayedReply(true);
QMetaObject::invokeMethod(this, &MyObject::process, Qt::QueuedConnection);
return QString();
}El ejemplo ilustra los dos usos típicos: el envío de respuestas de error y el de respuestas diferidas.
Nota: no crees subclases de QDBusContext y QDBusAbstractAdaptor al mismo tiempo. QDBusContext debe aparecer en el objeto real, no en el adaptador. Si es necesario determinar el contexto desde el código del adaptador, utiliza una herencia pública y accede a las funciones mediante QObject::parent().
Documentación de las funciones miembro
QDBusContext::QDBusContext()
Crea un objeto QDBusContext vacío.
[noexcept] QDBusContext::~QDBusContext()
Un destructor vacío.
bool QDBusContext::calledFromDBus() const
Devuelve « true » si se está procesando una llamada D-Bus. Si esta función devuelve « true », el resto de funciones de esta clase están disponibles.
El acceso a dichas funciones cuando esta función devuelve « false » no está definido y puede provocar fallos del sistema.
QDBusConnection QDBusContext::connection() const
Devuelve la conexión desde la que se recibió esta llamada.
bool QDBusContext::isDelayedReply() const
Devuelve ` true ` si esta llamada va a tener una respuesta retrasada.
Véase también setDelayedReply().
const QDBusMessage &QDBusContext::message() const
Devuelve el mensaje que generó esta llamada.
void QDBusContext::sendErrorReply(const QString &name, const QString &msg = QString()) const
Envía un error « name » como respuesta al llamante. El parámetro opcional « msg » es un texto legible para el usuario que explica el fallo.
Si se envía un error, Qt D-Bus ignorará el valor de retorno y cualquier parámetro de salida del slot invocado.
void QDBusContext::sendErrorReply(QDBusError::ErrorType type, const QString &msg = QString()) const
Envía un error « type » como respuesta al llamante. El parámetro opcional « msg » es un texto legible para el usuario que explica el fallo.
Si se envía un error, Qt D-Bus ignorará el valor de retorno y cualquier parámetro de salida de la ranura llamada.
Se trata de una función sobrecargada.
void QDBusContext::setDelayedReply(bool enable) const
Establece si esta llamada tendrá una respuesta diferida o no.
Si « enable » es «false», « Qt D-Bus » generará automáticamente una respuesta al autor de la llamada, si es necesario, tan pronto como devuelva el slot llamado.
Si enable es «true», Qt D-Bus no generará respuestas automáticas. Además, ignorará el valor de retorno de la ranura y cualquier parámetro de salida. En su lugar, el objeto invocado se encarga de almacenar el mensaje entrante y de enviar una respuesta o un error más adelante.
Si no se envía una respuesta, D-Bus generará un error automático por tiempo de espera agotado.
Véase también isDelayedReply().
© 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.