En esta página

QDBusAbstractInterface Class

La clase `QDBusAbstractInterface` es la clase base de todas las interfaces de D-Bus en el enlace ` Qt D-Bus `, lo que permite acceder a interfaces remotas. Más información...

Encabezado: #include <QDBusAbstractInterface>
CMake: find_package(Qt6 REQUIRED COMPONENTS DBus)
target_link_libraries(mytarget PRIVATE Qt6::DBus)
qmake: QT += dbus
Heredado de: QObject
Heredado por:

QDBusConnectionInterface y QDBusInterface

Funciones públicas

virtual ~QDBusAbstractInterface()
QDBusPendingCall asyncCall(const QString &method, Args &&... args)
QDBusPendingCall asyncCallWithArgumentList(const QString &method, const QList<QVariant> &args)
QDBusMessage call(const QString &method, Args &&... args)
QDBusMessage call(QDBus::CallMode mode, const QString &method, Args &&... args)
QDBusMessage callWithArgumentList(QDBus::CallMode mode, const QString &method, const QList<QVariant> &args)
bool callWithCallback(const QString &method, const QList<QVariant> &args, QObject *receiver, const char *returnMethod, const char *errorMethod)
bool callWithCallback(const QString &method, const QList<QVariant> &args, QObject *receiver, const char *slot)
QDBusConnection connection() const
QString interface() const
(since 6.7) bool isInteractiveAuthorizationAllowed() const
bool isValid() const
QDBusError lastError() const
QString path() const
QString service() const
(since 6.7) void setInteractiveAuthorizationAllowed(bool enable)
void setTimeout(int timeout)
int timeout() const

Descripción detallada

Las clases de código generado también derivan de QDBusAbstractInterface; todos los métodos descritos aquí también son válidos para las clases de código generado. Además de las descritas aquí, las clases de código generado proporcionan funciones miembro para los métodos remotos, lo que permite comprobar en tiempo de compilación que los parámetros y valores de retorno sean correctos, así como la coincidencia de tipos de propiedades y la coincidencia de parámetros de señales.

Véase también El compilador de QDBus y QDBusInterface.

Documentación de las funciones miembro

[virtual noexcept] QDBusAbstractInterface::~QDBusAbstractInterface()

Libera los recursos de este objeto.

template <typename... Args> QDBusPendingCall QDBusAbstractInterface::asyncCall(const QString &method, Args &&... args)

Llama al método ` method ` de esta interfaz y le pasa ` args ` como argumento. Todos los valores de ` args ` deben ser convertibles a ` QVariant`.

Los parámetros de call se pasan a la función remota a través de D-Bus como argumentos de entrada. El objeto QDBusPendingCall devuelto se puede utilizar para obtener información sobre la respuesta.

Se puede utilizar de la siguiente manera:

QDBusPendingCall pcall = interface->asyncCall("GetAPIVersion"_L1);
auto watcher = new QDBusPendingCallWatcher(pcall, this);

QObject::connect(watcher, &QDBusPendingCallWatcher::finished, this,
                 [&](QDBusPendingCallWatcher *w) {
    QString value = retrieveValue();
    QDBusPendingReply<int> reply(*w);
    QDBusPendingCall pcall;
    if (reply.argumentAt<0>() >= 14)
        pcall = interface->asyncCall("ProcessWorkUnicode"_L1, value);
    else
        pcall = interface->asyncCall("ProcessWork"_L1, "UTF-8"_L1, value.toUtf8());

    w = new QDBusPendingCallWatcher(pcall);
    QObject::connect(w,  &QDBusPendingCallWatcher::finished, this,
                     &Abstract_DBus_Interface::callFinishedSlot);
});

Este ejemplo ilustra la llamada a la función con 0, 1 y 2 parámetros, y muestra los diferentes tipos de parámetros que se pasan en cada caso (la primera llamada a "ProcessWorkUnicode" contendrá una cadena Unicode; la segunda llamada a "ProcessWork" contendrá una cadena y una matriz de bytes). Véase call() para ver el mismo ejemplo en llamadas bloqueantes (sincrónicas).

Nota: Antes de Qt 5.14, esta función aceptaba un máximo de solo ocho (8) argumentos.

Nota: Las llamadas amétodos de objetos locales de tipo ` QDBusServer` nunca son asíncronas debido a limitaciones de implementación.

Véase también asyncCallWithArgumentList().

QDBusPendingCall QDBusAbstractInterface::asyncCallWithArgumentList(const QString &method, const QList<QVariant> &args)

Realiza una llamada al método remoto especificado por ` method ` en esta interfaz, utilizando ` args ` como argumentos. Esta función devuelve un objeto ` QDBusPendingCall ` que puede utilizarse para realizar un seguimiento del estado de la respuesta y acceder a su contenido una vez que haya llegado.

Normalmente, las llamadas deben realizarse mediante ` asyncCall()`.

Nota: Las llamadas amétodos de objetos registrados por la propia aplicación nunca son asíncronas debido a limitaciones de implementación.

Nota: Esta función es segura para subprocesos.

template <typename... Args> QDBusMessage QDBusAbstractInterface::call(const QString &method, Args &&... args)

Llama al método « method » de esta interfaz y le pasa « args » como argumento. Todos los « args » deben ser convertibles a « QVariant ».

Los parámetros de ` call ` se pasan a la función remota a través de D-Bus como argumentos de entrada. Los argumentos de salida se devuelven en la respuesta de ` QDBusMessage `. Si la respuesta es un error, ` lastError()` también se establecerá con el contenido del mensaje de error.

Se puede utilizar de la siguiente manera:

QString value = retrieveValue();
QDBusMessage reply;

QDBusReply<int> api = interface->call("GetAPIVersion"_L1);
if (api >= 14)
  reply = interface->call("ProcessWorkUnicode"_L1, value);
else
  reply = interface->call("ProcessWork"_L1, "UTF-8"_L1, value.toUtf8());

Este ejemplo ilustra la llamada a la función con 0, 1 y 2 parámetros y muestra los diferentes tipos de parámetros que se pasan en cada caso (la primera llamada a "ProcessWorkUnicode" contendrá una cadena Unicode; la segunda llamada a "ProcessWork" contendrá una cadena y una matriz de bytes). Véase asyncCall() para ver el mismo ejemplo en llamadas no bloqueantes (asíncronas).

Nota: Antes de Qt 5.14, esta función aceptaba un máximo de solo ocho (8) argumentos.

Véase también callWithArgumentList().

template <typename... Args> QDBusMessage QDBusAbstractInterface::call(QDBus::CallMode mode, const QString &method, Args &&... args)

Llama al método « method » de esta interfaz y le pasa « args » como parámetro. Todos los « args » deben ser convertibles a « QVariant ».

Si mode es NoWaitForReply, esta función volverá inmediatamente tras realizar la llamada, sin esperar una respuesta del método remoto. De lo contrario, mode indica si esta función debe activar el bucle de eventos de Qt mientras espera a que llegue la respuesta.

Si esta función vuelve a entrar en el bucle de eventos de Qt para esperar la respuesta, excluirá las entradas del usuario. Durante la espera, puede enviar señales y otras llamadas a métodos a tu aplicación. Por lo tanto, esta debe estar preparada para gestionar la reentrada cada vez que se realice una llamada con call().

Nota: Antes de Qt 5.14, esta función aceptaba un máximo de solo ocho (8) argumentos.

Se trata de una función sobrecargada.

Véase también ` callWithArgumentList()`.

QDBusMessage QDBusAbstractInterface::callWithArgumentList(QDBus::CallMode mode, const QString &method, const QList<QVariant> &args)

Realiza una llamada al método remoto especificado por ` method ` en esta interfaz, utilizando ` args ` como argumentos. Esta función devuelve el mensaje recibido como respuesta, que puede ser un ` QDBusMessage::ReplyMessage ` normal (que indica que la operación se ha realizado con éxito) o un ` QDBusMessage::ErrorMessage ` (si la llamada ha fallado). El parámetro ` mode ` especifica cómo debe realizarse esta llamada.

Si la llamada se realiza con éxito, lastError() se vaciará; de lo contrario, contendrá el error que haya producido esta llamada.

Normalmente, debes realizar las llamadas utilizando call().

Advertencia: Si utilizas UseEventLoop, tu código debe estar preparado para gestionar cualquier reentrada: pueden entregarse otras llamadas a métodos y señales antes de que esta función devuelva un resultado, así como otras señales y eventos de Qt en cola.

Nota: Esta función es segura para subprocesos.

bool QDBusAbstractInterface::callWithCallback(const QString &method, const QList<QVariant> &args, QObject *receiver, const char *returnMethod, const char *errorMethod)

Realiza una llamada al método remoto especificado por ` method ` en esta interfaz, utilizando ` args ` como argumentos. Esta función devuelve el resultado inmediatamente después de poner la llamada en cola. La respuesta de la función remota se envía a ` returnMethod ` en el objeto ` receiver`. Si se produce un error, se llama en su lugar a ` errorMethod ` en el objeto ` receiver `.

Esta función devuelve true si la puesta en cola se realiza correctamente. Esto no indica que la llamada ejecutada haya tenido éxito. Si falla, se llama a errorMethod. Si la puesta en cola falla, esta función devuelve false y no se llamará a ningún slot.

La función ` returnMethod ` debe tener como parámetros los tipos devueltos por la llamada a la función. Opcionalmente, puede tener un parámetro ` QDBusMessage ` como último o único parámetro. La función ` errorMethod ` debe tener un ` QDBusError ` como único parámetro.

Nota: Las llamadas amétodos de objetos registrados por la propia aplicación nunca son asíncronas debido a limitaciones de implementación.

Véase también QDBusError y QDBusMessage.

bool QDBusAbstractInterface::callWithCallback(const QString &method, const QList<QVariant> &args, QObject *receiver, const char *slot)

Esta función está obsoleta. Utiliza la versión sobrecargada.

Realiza una llamada al método remoto especificado por ` method ` en esta interfaz, utilizando ` args ` como argumentos. Esta función devuelve un valor inmediatamente después de poner la llamada en cola. La respuesta de la función remota o cualquier error que esta genere se envían a la ranura ` slot ` del objeto ` receiver`.

Esta función devuelve ` true ` si la puesta en cola se ha realizado correctamente; esto no indica que la llamada haya tenido éxito. Si falla, se llamará a la ranura con un mensaje de error. En esas circunstancias, no se establecerá ` lastError()`.

Se trata de una función sobrecargada.

Véase también QDBusError y QDBusMessage.

QDBusConnection QDBusAbstractInterface::connection() const

Devuelve la conexión a la que está asociada esta interfaz.

QString QDBusAbstractInterface::interface() const

Devuelve el nombre de esta interfaz.

[since 6.7] bool QDBusAbstractInterface::isInteractiveAuthorizationAllowed() const

Indica si, en el caso de las llamadas asíncronas, el solicitante está dispuesto a esperar a que se realice la autorización interactiva.

El valor por defecto es « false ».

Esta función se introdujo en Qt 6.7.

Véase también ` setInteractiveAuthorizationAllowed()` y ` QDBusMessage::setInteractiveAuthorizationAllowed()`.

bool QDBusAbstractInterface::isValid() const

Devuelve ` true ` si se trata de una referencia válida a un objeto remoto. Devuelve ` false ` si se ha producido un error durante la creación de esta interfaz (por ejemplo, si la aplicación remota no existe).

Nota: al trabajar con objetos remotos, no siempre es posible determinar si existen al crear un ` QDBusInterface`.

QDBusError QDBusAbstractInterface::lastError() const

Devuelve el error generado por la última operación o un error de tipo «no válido» si la última operación no generó ningún error.

QString QDBusAbstractInterface::path() const

Devuelve la ruta del objeto al que está asociada esta interfaz.

QString QDBusAbstractInterface::service() const

Devuelve el nombre del servicio al que está asociada esta interfaz.

[since 6.7] void QDBusAbstractInterface::setInteractiveAuthorizationAllowed(bool enable)

Configura si, en el caso de las llamadas asíncronas, el solicitante está dispuesto a esperar a que se produzca una autorización interactiva.

Si se establece « enable » en « true », los mensajes D-Bus generados para llamadas asíncronas a través de esta interfaz activarán el indicador « ALLOW_INTERACTIVE_AUTHORIZATION ».

Este indicador solo resulta útil cuando un código sin privilegios realiza una llamada a un método con más privilegios y se ha implementado un marco de autorización que permite una autorización posiblemente interactiva.

El valor predeterminado es ` false`.

Esta función se introdujo en Qt 6.7.

Véase también ` isInteractiveAuthorizationAllowed()` y ` QDBusMessage::setInteractiveAuthorizationAllowed()`.

void QDBusAbstractInterface::setTimeout(int timeout)

Establece el tiempo de espera, en milisegundos, para todas las futuras llamadas DBus a timeout. El valor -1 indica el tiempo de espera predeterminado de DBus (normalmente 25 segundos).

Véase también timeout().

int QDBusAbstractInterface::timeout() const

Devuelve el valor actual del tiempo de espera en milisegundos. -1 indica el tiempo de espera predeterminado de DBus (normalmente 25 segundos).

Véase también setTimeout().

© 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.