En esta página

QGrpcOperationContext Class

La clase QGrpcOperationContext proporciona el contexto para la comunicación entre una gRPC™ y un canal. Más...

Encabezado: #include <QGrpcOperationContext>
CMake: find_package(Qt6 REQUIRED COMPONENTS Grpc)
target_link_libraries(mytarget PRIVATE Qt6::Grpc)
Desde: Qt 6.7
Heredan de: QObject

Funciones públicas

virtual ~QGrpcOperationContext() override
const QGrpcCallOptions &callOptions() const &
(since 6.11) QtGrpc::RpcDescriptor descriptor() const
QLatin1StringView method() const
(since 6.11) quint64 operationId() const
QMetaType responseMetaType() const
std::shared_ptr<const QAbstractProtobufSerializer> serializer() const
(since 6.10) const QMultiHash<QByteArray, QByteArray> &serverInitialMetadata() const &
(until 6.13) const QHash<QByteArray, QByteArray> &serverMetadata() const &
(since 6.10) const QMultiHash<QByteArray, QByteArray> &serverTrailingMetadata() const &
QLatin1StringView service() const
void setResponseMetaType(QMetaType metaType)
(since 6.10) void setServerInitialMetadata(QMultiHash<QByteArray, QByteArray> &&metadata)
(until 6.13) void setServerMetadata(QHash<QByteArray, QByteArray> &&metadata)
(until 6.13) void setServerMetadata(const QHash<QByteArray, QByteArray> &metadata)
(since 6.10) void setServerTrailingMetadata(QMultiHash<QByteArray, QByteArray> &&metadata)

Señales

void cancelRequested()
void finished(const QGrpcStatus &status)
void messageReceived(const QByteArray &data)
(since 6.11) void serverInitialMetadataReceived(const QMultiHash<QByteArray, QByteArray> &metadata)
void writeMessageRequested(const QByteArray &data)
void writesDoneRequested()

Descripción detallada

QGrpcOperationContext se crea internamente cuando se solicita una llamada a procedimiento remoto (RPC), mediando en la interacción entre la solicitud de operación del cliente y el resultado de la operación del canal.

Las RPC solicitadas en la interfaz del cliente devuelven especializaciones de ` QGrpcOperation`, tales como ` QGrpcCallReply`, ` QGrpcServerStream`, ` QGrpcClientStream` o ` QGrpcBidiStream`. Estas clases se integran implícitamente con su homóloga subyacente de `QGrpcOperationContext`.

Nota: No utilices esta clase directamente a menos que estés implementando un canal personalizado.

Las señales contenidas en esta clase se utilizan para establecer la comunicación entre el ` QGrpcOperation `, orientado al cliente, y la implementación de ` QAbstractGrpcChannel `. Estas operaciones son de naturaleza asíncrona, y pueden operarse varias RPC en el mismo canal de forma simultánea. Normalmente, los canales tratan todas las operaciones por igual, y es responsabilidad del canal admitir y restringir correctamente el subconjunto de características que admite su tipo de RPC.

Las señales que solo debe emitir la implementación del canal son:

Las señales que emitirá ` QGrpcOperation ` y sus especializaciones son:

Las implementaciones personalizadas de ` QAbstractGrpcChannel ` deben gestionar las señales del cliente, ya que no se proporciona ninguna gestión predeterminada de señales, y emitir sus propias señales en consecuencia.

Documentación de las funciones miembro

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

Destruye el contexto de la operación.

[noexcept] const QGrpcCallOptions &QGrpcOperationContext::callOptions() const &

Devuelve las opciones de llamada que utiliza este contexto de operación.

Para conocer las opciones aplicables a todo el canal, consulta QGrpcChannelOptions.

[signal] void QGrpcOperationContext::cancelRequested()

Esta señal la emite QGrpcOperation al solicitar la cancelación de la comunicación.

Se espera que el canal conecte su lógica de cancelación a esta señal e intente cancelar la RPC y la finalice con un código de estado de « Cancelled ». No se puede garantizar que la cancelación se realice con éxito. No es necesario seguir procesando los datos recibidos de un canal y debe evitarse hacerlo.

Véase también QGrpcOperation::cancel.

[noexcept, since 6.11] QtGrpc::RpcDescriptor QGrpcOperationContext::descriptor() const

Devuelve el objeto « QtGrpc::RpcDescriptor » correspondiente a este contexto de operación.

Esta función se introdujo en Qt 6.11.

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

El canal debe emitir esta señal cuando finaliza una RPC.

Normalmente significa que el servidor ha enviado un « status » para el RPC solicitado y ha cerrado la conexión. Las implementaciones de ` QAbstractGrpcChannel ` deben detectar esta situación y emitir la señal.

Tras recibir esta señal, no debería producirse ninguna comunicación adicional a través de este contexto de operación. El lado del cliente puede entonces eliminar de forma segura el objeto RPC correspondiente.

Nota: Esta señal está implícitamente vinculada a su homóloga « QGrpcOperation ».

Véase también QGrpcOperation::finished.

[signal] void QGrpcOperationContext::messageReceived(const QByteArray &data)

El canal debe emitir esta señal cuando se reciba del servidor un nuevo fragmento de « data ».

En el caso de las transmisiones de cliente y las llamadas unarias, esto significa que ha llegado la única y última respuesta y que la comunicación está a punto de finalizar.

En el caso de los flujos de servidor y bidireccionales, el canal debe emitir esta señal de forma continua al recibir cada nuevo mensaje.

Nota: Esta señal está conectada implícitamente a su homóloga « QGrpcOperation ».

Véase también « QGrpcServerStream::messageReceived » y « QGrpcBidiStream::messageReceived ».

[noexcept] QLatin1StringView QGrpcOperationContext::method() const

Devuelve el nombre del método del servicio asociado a este contexto de operación.

[noexcept, since 6.11] quint64 QGrpcOperationContext::operationId() const

Devuelve el identificador único de este contexto de operación.

Cada ID es único en todos los canales durante toda la vida útil de la aplicación.

Esta función se introdujo en Qt 6.11.

QMetaType QGrpcOperationContext::responseMetaType() const

Devuelve el metatipo del mensaje de resultado RPC.

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

std::shared_ptr<const QAbstractProtobufSerializer> QGrpcOperationContext::serializer() const

Devuelve el serializador de este contexto de operación.

[noexcept, since 6.10] const QMultiHash<QByteArray, QByteArray> &QGrpcOperationContext::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.

Nota: Este método es utilizado de forma implícita por QGrpcOperation.

Esta función se introdujo en Qt 6.10.

Véase también setServerInitialMetadata(), QGrpcOperation::serverInitialMetadata() y serverTrailingMetadata().

[private signal, since 6.11] void QGrpcOperationContext::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 llamada RPC.

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

Nota: Se trata de una señal privada. Se puede utilizar en conexiones de señales, pero el usuario no puede emitirla.

Esta función se introdujo en Qt 6.11.

Véase también QGrpcOperation::serverInitialMetadataReceived y QGrpcBidiStream::writesDone.

[noexcept, until 6.13] const QHash<QByteArray, QByteArray> &QGrpcOperationContext::serverMetadata() 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.

Nota: Este método es utilizado de forma implícita por QGrpcOperation.

Véase también setServerMetadata(), serverInitialMetadata() y QGrpcOperation::serverInitialMetadata().

[noexcept, since 6.10] const QMultiHash<QByteArray, QByteArray> &QGrpcOperationContext::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.

Nota: Este método es utilizado de forma implícita por ` QGrpcOperation`.

Esta función se introdujo en Qt 6.10.

Véase también QGrpcOperation::serverTrailingMetadata() y setServerTrailingMetadata().

[noexcept] QLatin1StringView QGrpcOperationContext::service() const

Devuelve el nombre del servicio asociado a este contexto de operación.

void QGrpcOperationContext::setResponseMetaType(QMetaType metaType)

Almacena el objeto ` metaType ` del mensaje de resultado RPC.

Véase también responseMetaType().

[since 6.10] void QGrpcOperationContext::setServerInitialMetadata(QMultiHash<QByteArray, QByteArray> &&metadata)

Establece el valor de « metadata » recibido del servidor al inicio de la llamada RPC.

Esta función se introdujo en Qt 6.10.

Véase también serverInitialMetadata().

[until 6.13] void QGrpcOperationContext::setServerMetadata(QHash<QByteArray, QByteArray> &&metadata)

[until 6.13] void QGrpcOperationContext::setServerMetadata(const QHash<QByteArray, QByteArray> &metadata)

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

Utiliza en su lugar setServerInitialMetadata().

Establece los metadatos recibidos del servidor al inicio de la RPC.

Véase también setServerInitialMetadata().

[since 6.10] void QGrpcOperationContext::setServerTrailingMetadata(QMultiHash<QByteArray, QByteArray> &&metadata)

Establece el carácter de cierre « metadata » recibido del servidor al final de todos los mensajes de respuesta.

Esta función se introdujo en Qt 6.10.

Véase también serverTrailingMetadata().

[signal] void QGrpcOperationContext::writeMessageRequested(const QByteArray &data)

Esta señal la emiten QGrpcClientStream o QGrpcBidiStream cuando han serializado data y están listos para que un canal lo transmita.

Se espera que el canal conecte su lógica de escritura a esta señal y envuelva los datos serializados en encabezados relacionados con el canal antes de escribirlos en la red.

Véase también QGrpcClientStream::writeMessage y QGrpcBidiStream::writeMessage.

[signal] void QGrpcOperationContext::writesDoneRequested()

Esta señal la emiten QGrpcClientStream o QGrpcBidiStream para indicar que han terminado de escribir mensajes. El canal debe responder a esto cerrando parcialmente el flujo.

Nota: Tras recibir esta señal, ya no se permiten más operaciones de escritura para los RPC de flujo. El servidor aún puede enviar mensajes, que deben reenviarse mediante messageReceived().

Véase también QGrpcClientStream::writesDone y QGrpcBidiStream::writesDone.

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