QGrpcOperationContext Class

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 las opciones de todo el canal, consulte QGrpcChannelOptions.

[signal] void QGrpcOperationContext::cancelRequested()

Esta señal es emitida por QGrpcOperation cuando se solicita 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 terminarla con un código de estado Cancelled. No se puede garantizar el éxito de la cancelación. El procesamiento posterior de los datos recibidos de un canal no es necesario y debe evitarse.

Véase también QGrpcOperation::cancel.

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

Devuelve el QtGrpc::RpcDescriptor para este contexto de operación.

Esta función se introdujo en Qt 6.11.

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

Esta señal debe ser emitida por el canal cuando finaliza una RPC.

Normalmente significa que el servidor envió un status para la RPC solicitada y cerró la conexión. Las implementaciones de QAbstractGrpcChannel deberían detectar esta situación y emitir la señal.

Después de recibir esta señal, no debe haber más comunicación a través de este contexto de operación. El cliente puede entonces eliminar de forma segura el objeto RPC correspondiente.

Véase también QGrpcOperation::finished.

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

Esta señal debe ser emitida por el canal cuando se recibe un nuevo trozo de data desde el servidor.

Para flujos de clientes y llamadas unarias, esto significa que la respuesta única y final ha llegado y la comunicación está a punto de terminar.

Para flujos de servidor y bidireccionales, esta señal debe ser emitida continuamente por el canal al recibir cada nuevo mensaje.

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 para este contexto de operación.

Cada ID es único en todos los canales durante el tiempo de vida 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 establecer la llamada. Pueden incluir pares clave-valor que proporcionan contexto para la llamada.

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

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

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 &

Esta función quedará obsoleta en la versión 6.13.

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

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

Los metadatos iniciales son enviados por el servidor inmediatamente después de que se establezca la llamada. Pueden incluir pares clave-valor que proporcionan contexto para la llamada.

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 después de todos los mensajes de respuesta.

El servidor sólo envía los metadatos finales una vez que se han enviado todos los mensajes de respuesta y justo antes de que finalice la RPC. Puede incluir pares clave-valor que proporcionen contexto adicional sobre la llamada completada.

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 la dirección metaType del mensaje de resultado RPC.

Véase también responseMetaType().

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

Establece el metadata recibido del servidor al inicio de la RPC.

Esta función se introdujo en Qt 6.10.

Véase también serverInitialMetadata().

Esta función quedará obsoleta en la versión 6.13.

Utilice setServerInitialMetadata() en su lugar.

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 final de metadata recibido del servidor después 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 es emitida por QGrpcClientStream o QGrpcBidiStream cuando ha serializado data listo para que un canal lo entregue.

Se espera que el canal conecte su lógica de escritura a esta señal y envuelva los datos serializados en cabeceras relacionadas con el canal antes de escribirlos en el cable.

Ver también QGrpcClientStream::writeMessage y QGrpcBidiStream::writeMessage.

[signal] void QGrpcOperationContext::writesDoneRequested()

Esta señal es emitida por QGrpcClientStream o QGrpcBidiStream para indicar que ha terminado de escribir mensajes. El canal debe responder a esto cerrando a la mitad el flujo.

Ver también QGrpcClientStream::writesDone y QGrpcBidiStream::writesDone.