En esta página

QGrpcOperation Class

La clase QGrpcOperation proporciona operaciones comunes para gestionar la gRPC™ comunicación desde el lado del cliente. Más...

Encabezado: #include <QGrpcOperation>
CMake: find_package(Qt6 REQUIRED COMPONENTS Grpc)
target_link_libraries(mytarget PRIVATE Qt6::Grpc)
Desde: Qt 6.5
Heredado de: QObject
Heredado por:

QGrpcBidiStream, QGrpcCallReply, QGrpcClientStream y QGrpcServerStream

Funciones públicas

virtual ~QGrpcOperation() override
bool isFinished() const
(until 6.13) const QHash<QByteArray, QByteArray> &metadata() const &
QLatin1StringView method() const
std::optional<T> read() const
(since 6.8) bool read(QProtobufMessage *message) const
QMetaType responseMetaType() const
(since 6.10) const QMultiHash<QByteArray, QByteArray> &serverInitialMetadata() const &
(since 6.10) const QMultiHash<QByteArray, QByteArray> &serverTrailingMetadata() const &

Ranuras públicas

void cancel()

Señales

void finished(const QGrpcStatus &status)
(since 6.11) void serverInitialMetadataReceived(const QMultiHash<QByteArray, QByteArray> &metadata)

Descripción detallada

QGrpcOperation sirve como clase base para los cuatro gRPC™ tipos de método: « QGrpcCallReply » (llamadas unarias), « QGrpcServerStream » (transmisión del servidor), « QGrpcClientStream » (transmisión del cliente) y « QGrpcBidiStream » (transmisión bidireccional). Proporciona una interfaz común para interactuar con estas llamadas a procedimientos remotos (RPC).

Cada QGrpcOperation se corresponde con una RPC específica solicitada a través de la interfaz de cliente generada.

Para obtener una visión general de alto nivel, consulta la Guía del cliente de «Qt GRPC ».

Documentación de las funciones de miembro

[override virtual noexcept] QGrpcOperation::~QGrpcOperation()

Destruye la « QGrpcOperation ».

[slot] void QGrpcOperation::cancel()

Intenta cancelar el RPC de forma inmediata. No se puede garantizar que la cancelación se realice con éxito. Emite la señal « finished » con un código de estado « Cancelled ».

Véase también QGrpcOperationContext::cancelRequested.

[signal] void QGrpcOperation::finished(const QGrpcStatus &status)

Esta señal se emite cuando finaliza un RPC iniciado previamente. El objeto « status » proporciona información adicional sobre el resultado del RPC.

Una vez recibida esta señal, no deben realizarse más operaciones de lectura ni de escritura en el objeto de operación. En este momento, es seguro reutilizar o destruir el objeto RPC.

Nota: Esta señal se emite solo una vez y, en la mayoría de los casos, es recomendable desconectarse inmediatamente después de recibirla para evitar problemas, como que las capturas lambda no se destruyan tras recibir la señal. Una forma sencilla de lograrlo es utilizando el tipo de conexión « SingleShotConnection ». Consulta «RPC de un solo disparo» para obtener más detalles.

[noexcept] bool QGrpcOperation::isFinished() const

Devuelve «true» si esta operación ha finalizado, lo que significa que no pueden realizarse más operaciones en el RPC correspondiente; en caso contrario, devuelve «false».

[noexcept, until 6.13] const QHash<QByteArray, QByteArray> &QGrpcOperation::metadata() const &

Está previsto que esta función quede obsoleta en la versión 6.13.

Utiliza en su lugar serverInitialMetadata() y serverTrailingMetadata().

Devuelve los metadatos iniciales recibidos del servidor antes de cualquier mensaje de respuesta.

El servidor envía los metadatos iniciales inmediatamente después de que se establezca la llamada. Pueden incluir pares clave-valor que proporcionan contexto para la llamada.

Nota: Las claves con el prefijo grpc- o qtgrpc- están reservadas por gRPC y QtGrpc. Las entradas proporcionadas que las utilicen se ignoran al construir la solicitud. Los canales concretos pueden imponer restricciones adicionales; véase QGrpcHttp2Channel#Reserved metadata keys.

Véase también serverInitialMetadata() y serverTrailingMetadata().

[noexcept] QLatin1StringView QGrpcOperation::method() const

Devuelve el nombre del método asociado a esta operación RPC.

template <typename T> requires QtProtobuf::if_protobuf_message<T> std::optional<T> QGrpcOperation::read() const

Lee un mensaje de una matriz de bytes sin procesar almacenada en este objeto de operación.

Devuelve un mensaje deserializado opcional. En caso de error, se devuelve « std::nullopt ».

Nota: Esta función solo participa en la resolución de sobrecargas si ` T ` es una subclase de ` QProtobufMessage`.

Véase también ` read` (`QProtobufMessage *`).

[since 6.8] bool QGrpcOperation::read(QProtobufMessage *message) const

Lee un mensaje de una matriz de bytes sin procesar almacenada en este objeto de operación.

La función escribe el valor deserializado en el puntero ` message `.

Si la deserialización se realiza correctamente, esta función devuelve ` true`. De lo contrario, devuelve ` false`.

Esta función se introdujo en Qt 6.8.

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

QMetaType QGrpcOperation::responseMetaType() const

Devuelve el metatipo del mensaje de respuesta RPC.

[noexcept, since 6.10] const QMultiHash<QByteArray, QByteArray> &QGrpcOperation::serverInitialMetadata() const &

Devuelve los metadatos iniciales recibidos del servidor antes de cualquier mensaje de respuesta.

El servidor envía los metadatos iniciales inmediatamente después de que se establezca la llamada. Pueden incluir pares clave-valor que proporcionan contexto para la llamada.

Nota: Las claves con el prefijo « grpc- » o « qtgrpc- » están reservadas por gRPC y QtGrpc. Las entradas proporcionadas que las utilicen se ignoran al construir la solicitud. Los canales concretos pueden imponer restricciones adicionales; véase QGrpcHttp2Channel#Reserved metadata keys.

Los metadatos pueden contener varias entradas bajo la misma clave.

Esta función se introdujo en Qt 6.10.

Véase también serverInitialMetadataReceived() y serverTrailingMetadata().

[signal, since 6.11] void QGrpcOperation::serverInitialMetadataReceived(const QMultiHash<QByteArray, QByteArray> &metadata)

Esta señal se emite cuando el servidor responde con sus metadatos iniciales. Los metadatos iniciales del servidor se envían al cliente antes de la respuesta inicial de una RPC.

Los metadatos recibidos se proporcionan en metadata y también están disponibles a través de serverInitialMetadata().

Nota: Las claves con el prefijo grpc- o qtgrpc- están reservadas por gRPC y QtGrpc. Las entradas proporcionadas que las utilicen se ignoran al construir la solicitud. Algunos canales concretos pueden imponer restricciones adicionales; véase QGrpcHttp2Channel#Reserved metadata keys.

Esta función se introdujo en Qt 6.11.

Véase también serverInitialMetadata().

[noexcept, since 6.10] const QMultiHash<QByteArray, QByteArray> &QGrpcOperation::serverTrailingMetadata() const &

Devuelve los metadatos finales recibidos del servidor tras todos los mensajes de respuesta.

Los metadatos finales solo los envía el servidor una vez que se han enviado todos los mensajes de respuesta y justo antes de que finalice la llamada RPC. Pueden incluir pares clave-valor que proporcionan contexto adicional sobre la llamada completada.

Nota: Las claves con el prefijo « grpc- » o « qtgrpc- » están reservadas por gRPC y QtGrpc. Las entradas proporcionadas que las utilicen se ignoran al construir la solicitud. Los canales concretos pueden imponer restricciones adicionales; véase QGrpcHttp2Channel#Reserved metadata keys.

Los metadatos pueden contener varias entradas bajo la misma clave.

Esta función se introdujo en Qt 6.10.

Véase también serverInitialMetadata().

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