QDBusPendingReply Class
La clase QDBusPendingReply contiene la respuesta a una llamada asíncrona a un método. Más información...
| Encabezado: | #include <QDBusPendingReply> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS DBus) target_link_libraries(mytarget PRIVATE Qt6::DBus) |
| qmake: | QT += dbus |
| Heredado de: | QDBusPendingReplyBase |
Tipos públicos
| enum { Count } |
Funciones públicas
| QDBusPendingReply() | |
| QDBusPendingReply(const QDBusMessage &message) | |
| QDBusPendingReply(const QDBusPendingCall &call) | |
| QDBusPendingReply(const QDBusPendingReply<Types...> &other) | |
(since 6.10) | QDBusPendingReply(QDBusPendingReply<Types...> &&other) |
| QVariant | argumentAt(int index) const |
| int | count() const |
| QDBusError | error() const |
| bool | isError() const |
| bool | isFinished() const |
| bool | isValid() const |
| QDBusMessage | reply() const |
| typename Select<0>::Type | value() const |
| void | waitForFinished() |
| operator typename Select<0>::Type() const | |
(since 6.10) int & | operator=(QDBusPendingReply<Types...> &&other) |
| QDBusPendingReply<Types...> & | operator=(const QDBusMessage &message) |
| QDBusPendingReply<Types...> & | operator=(const QDBusPendingCall &call) |
| int & | operator=(const QDBusPendingReply<Types...> &other) |
Descripción detallada
QDBusPendingReply es una clase de plantilla variádica. Los parámetros de la plantilla son los tipos que se utilizarán para extraer el contenido de los datos de la respuesta.
Esta clase tiene una funcionalidad similar a la de ` QDBusReply`, pero con dos diferencias importantes:
- QDBusReply acepta exactamente un tipo de retorno, mientras que QDBusPendingReply puede tener cualquier número de tipos
- QDBusReply solo funciona con respuestas ya completadas, mientras que QDBusPendingReply permite esperar respuestas de llamadas pendientes
Mientras que con ` QDBusReply ` se escribiría:
QDBusReply<QString> reply = interface->call("RemoteMethod");
if (reply.isValid())
// use the returned value
useValue(reply.value());
else
// call failed. Show an error condition.
showError(reply.error());con QDBusPendingReply, el código equivalente (incluida la espera bloqueante de la respuesta) sería:
QDBusPendingReply<QString> reply = iface->asyncCall("RemoteMethod");
reply.waitForFinished();
if (reply.isError())
// call failed. Show an error condition.
showErrorD(reply.error());
else
// use the returned value
useValue(reply.value());Para llamadas a métodos que tengan más de un argumento de salida, con ` QDBusReply` se escribiría:
reply = interface->call("RemoteMethod");mientras que con `QDBusPendingReply`, todos los argumentos de salida deben ser parámetros de plantilla:
QDBusPendingReply<bool, QString> reply = iface->asyncCall("RemoteMethod");
reply.waitForFinished();
if (!reply.isError()) {
if (reply.argumentAt<0>())
showSuccess(reply.argumentAt<1>());
else
showFailure(reply.argumentAt<1>());
}Los objetos `QDBusPendingReply` pueden asociarse a objetos ` QDBusPendingCallWatcher `, que emiten señales cuando llega la respuesta.
Véase también QDBusPendingCallWatcher y QDBusReply.
Documentación sobre los tipos de miembro
[anonymous] enum
| Constante | Valor | Descripción |
|---|---|---|
QDBusPendingReply::Count | std::is_same_v<typename Select<0>::Type, void> ? 0 : sizeof...(Types) | El número de argumentos que se espera que tenga la respuesta |
Documentación de la función de miembro
[default] QDBusPendingReply::QDBusPendingReply()
Crea un objeto `QDBusPendingReply` vacío. Si no se le asigna un objeto ` QDBusPendingCall ` a esta respuesta, `QDBusPendingReply` no puede realizar ninguna acción. Todas las funciones devuelven sus valores de error.
QDBusPendingReply::QDBusPendingReply(const QDBusMessage &message)
Crea un objeto `QDBusPendingReply` cuyo contenido procederá del mensaje ` message`. En este caso, dicho objeto ya se encontrará en estado «finalizado» y se podrá acceder al contenido de la respuesta.
Véase también isFinished().
QDBusPendingReply::QDBusPendingReply(const QDBusPendingCall &call)
Crea un objeto `QDBusPendingReply` que obtendrá su contenido de la llamada asíncrona pendiente ` call `. Este objeto `QDBusPendingReply` compartirá la misma referencia de llamada pendiente que ` call`.
[implicit] QDBusPendingReply::QDBusPendingReply(const QDBusPendingReply<Types...> &other)
Crea una copia del objeto `QDBusPendingReply` de ` other `. Al igual que en ` QDBusPendingCall ` y ` QDBusPendingCallWatcher`, este objeto `QDBusPendingReply` compartirá la misma referencia de llamada pendiente. Todas las copias comparten los mismos valores de retorno.
[implicit, since 6.10] QDBusPendingReply::QDBusPendingReply(QDBusPendingReply<Types...> &&other)
Moves: crea un nuevo objeto `QDBusPendingReply` a partir de ` other`.
Esta función se introdujo en Qt 6.10.
QVariant QDBusPendingReply::argumentAt(int index) const
Devuelve el argumento situado en la posición index dentro del contenido de la respuesta. Si la respuesta no contiene tantos elementos, el valor de retorno de esta función es indefinido (lo que probablemente provocará un fallo de aserción), por lo que es importante comprobar que el procesamiento haya finalizado y que la respuesta sea válida.
Si la respuesta no contiene un argumento en la posición index o si la respuesta era un error, esta función devuelve un QVariant no válido. Dado que los mensajes de D-Bus nunca pueden contener QVariants no válidos, este valor de retorno puede utilizarse para detectar una condición de error.
[constexpr] int QDBusPendingReply::count() const
Devuelve el número de argumentos que debe tener la respuesta. Este número coincide con el número de parámetros de plantilla no nulos de esta clase.
Si la respuesta llega con un número diferente de argumentos (o con tipos diferentes), se transformará en una respuesta de error que indicará una firma incorrecta.
QDBusError QDBusPendingReply::error() const
Recupera el contenido del error del mensaje de respuesta, si se ha completado su procesamiento. Si el mensaje de respuesta no se ha procesado por completo o si se trata de un mensaje de respuesta normal (sin error), esta función devuelve un valor no válido ` QDBusError`.
bool QDBusPendingReply::isError() const
Devuelve ` true ` si la respuesta contiene un mensaje de error, y `false` si contiene una respuesta normal del método.
Si la llamada pendiente aún no ha finalizado su procesamiento, esta función también devuelve « true ».
bool QDBusPendingReply::isFinished() const
Devuelve « true » si la llamada pendiente ha finalizado su procesamiento y se ha recibido la respuesta. Si esta función devuelve « true », los métodos « isError()», « error()» y « reply()» deben devolver información válida.
Ten en cuenta que esta función solo cambia de estado si se llama a waitForFinished() o si se produce un evento D-Bus externo, lo que, en general, solo ocurre si se vuelve a la ejecución del bucle de eventos.
Véase también QDBusPendingCallWatcher::isFinished().
bool QDBusPendingReply::isValid() const
Devuelve « true » si la respuesta contiene un mensaje de respuesta normal, y «false» si contiene cualquier otra cosa.
Si la llamada pendiente no ha finalizado su procesamiento, esta función devuelve «false».
QDBusMessage QDBusPendingReply::reply() const
Recupera el mensaje de respuesta recibido para la llamada asíncrona que se envió, siempre que haya finalizado su procesamiento. Si la llamada pendiente no ha finalizado, esta función devuelve un objeto ` QDBusMessage ` de tipo ` QDBusMessage::InvalidMessage`.
Una vez finalizado el procesamiento, el tipo de mensaje será o bien un mensaje de error o bien un mensaje de respuesta normal del método.
typename Select<0>::Type QDBusPendingReply::value() const
Devuelve el primer argumento de esta respuesta, convertido al tipo ` Types[0] ` (el primer parámetro de plantilla de esta clase). Esto equivale a llamar a ` argumentAt<0>()`.
Esta función se proporciona para mayor comodidad, a modo de equivalente a la función QDBusReply::value().
Ten en cuenta que, si la respuesta aún no ha llegado, esta función provoca que el hilo que la invoca se bloquee hasta que se procese la respuesta.
Si la respuesta es un error, esta función devuelve un objeto ` Types[0] ` construido por defecto, que puede resultar indistinguible de un valor válido. Para determinar de forma fiable si el mensaje era un error, utilice ` isError()`.
void QDBusPendingReply::waitForFinished()
Suspende la ejecución del hilo que realiza la llamada hasta que se reciba y se procese la respuesta. Una vez que esta función devuelva un valor, la función ` isFinished()` debería devolver «true», lo que indica que el contenido de la respuesta está listo para ser procesado.
Véase también QDBusPendingCallWatcher::waitForFinished().
QDBusPendingReply::operator typename Select<0>::Type() const
Devuelve el primer argumento de esta respuesta, convertido al tipo ` Types[0] ` (el primer parámetro de plantilla de esta clase). Esto equivale a llamar a ` argumentAt<0>()`.
Esta función se proporciona para mayor comodidad, a modo de equivalente a la función QDBusReply::value().
Ten en cuenta que, si la respuesta aún no ha llegado, esta función hace que el hilo que la invoca se bloquee hasta que se procese la respuesta.
Si la respuesta es un error, esta función devuelve un objeto ` Types[0] ` construido por defecto, que puede resultar indistinguible de un valor válido. Para determinar de forma fiable si el mensaje era un error, utiliza ` isError()`.
[implicit, since 6.10] int &QDBusPendingReply::operator=(QDBusPendingReply<Types...> &&other)
La función «move-assigns» asigna other a esta instancia de QDBusPendingReply y elimina la referencia a la llamada pendiente actual. Si la referencia actual corresponde a una llamada pendiente no finalizada y esta es la última referencia, la llamada pendiente se cancelará y no habrá forma de recuperar el contenido de la respuesta cuando llegue.
Esta función se introdujo en Qt 6.10.
QDBusPendingReply<Types...> &QDBusPendingReply::operator=(const QDBusMessage &message)
Hace que este objeto obtenga su contenido del mensaje message y elimina la referencia a la llamada pendiente actual. Si la referencia actual corresponde a una llamada pendiente no finalizada y esta es la última referencia, la llamada pendiente se cancelará y no habrá forma de recuperar el contenido de la respuesta cuando llegue.
Una vez finalizada esta función, el objeto ` QDBusPendingReply ` se encontrará en su estado «finalizado» y se podrá acceder al contenido de ` message `.
Véase también isFinished().
QDBusPendingReply<Types...> &QDBusPendingReply::operator=(const QDBusPendingCall &call)
Hace que este objeto obtenga su contenido de la llamada pendiente call y elimina la referencia a la llamada pendiente actual. Si la referencia actual corresponde a una llamada pendiente no finalizada y esta es la última referencia, la llamada pendiente se cancelará y no habrá forma de recuperar el contenido de la respuesta cuando llegue.
[implicit] int &QDBusPendingReply::operator=(const QDBusPendingReply<Types...> &other)
Crea una copia de ` other ` y elimina la referencia a la llamada pendiente actual. Si la referencia actual corresponde a una llamada pendiente no finalizada y esta es la última referencia, la llamada pendiente se cancelará y no habrá forma de recuperar el contenido de la respuesta cuando llegue.
© 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.