QGrpcCallOptions Class
La clase QGrpcCallOptions ofrece diversas opciones para ajustar con precisión cada llamada RPC. Más información...
| Encabezado: | #include <QGrpcCallOptions> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Grpc) target_link_libraries(mytarget PRIVATE Qt6::Grpc) |
| Desde: | Qt 6.6 |
| En QML: | GrpcCallOptions |
Comparaciones de QGrpcCallOptions
| Categoría | Tipos comparables |
|---|---|
| igualdad | QGrpcCallOptions |
Funciones públicas
| QGrpcCallOptions() | |
| QGrpcCallOptions(const QGrpcCallOptions &other) | |
| QGrpcCallOptions(QGrpcCallOptions &&other) | |
| ~QGrpcCallOptions() | |
(since 6.10) QGrpcCallOptions & | addMetadata(QByteArrayView key, QByteArrayView value) |
| std::optional<std::chrono::milliseconds> | deadlineTimeout() const |
(since 6.11) std::optional<bool> | filterServerMetadata() const |
(since 6.12) std::optional<quint64> | maximumReceiveMessageSize() const |
(until 6.13) QHash<QByteArray, QByteArray> | metadata() && |
(until 6.13) const QHash<QByteArray, QByteArray> & | metadata() const & |
(since 6.10) QMultiHash<QByteArray, QByteArray> | metadata(QtGrpc::MultiValue_t) && |
(since 6.10) const QMultiHash<QByteArray, QByteArray> & | metadata(QtGrpc::MultiValue_t) const & |
(since 6.12) std::optional<QtGrpc::CompressionAlgorithm> | requestCompression() const |
| QGrpcCallOptions & | setDeadlineTimeout(std::chrono::milliseconds timeout) |
(since 6.11) QGrpcCallOptions & | setFilterServerMetadata(bool value) |
(since 6.12) QGrpcCallOptions & | setMaximumReceiveMessageSize(quint64 size) |
(until 6.13) QGrpcCallOptions & | setMetadata(QHash<QByteArray, QByteArray> &&metadata) |
(since 6.10) QGrpcCallOptions & | setMetadata(QMultiHash<QByteArray, QByteArray> &&metadata) |
(until 6.13) QGrpcCallOptions & | setMetadata(const QHash<QByteArray, QByteArray> &metadata) |
(since 6.10) QGrpcCallOptions & | setMetadata(const QMultiHash<QByteArray, QByteArray> &metadata) |
(since 6.10) QGrpcCallOptions & | setMetadata(std::initializer_list<std::pair<QByteArray, QByteArray>> metadata) |
(since 6.12) QGrpcCallOptions & | setRequestCompression(QtGrpc::CompressionAlgorithm algorithm) |
(since 6.8) void | swap(QGrpcCallOptions &other) |
(since 6.8) | operator QVariant() const |
| QGrpcCallOptions & | operator=(QGrpcCallOptions &&other) |
| QGrpcCallOptions & | operator=(const QGrpcCallOptions &other) |
Elementos no miembros relacionados
(since 6.11) bool | operator!=(const QGrpcCallOptions &lhs, const QGrpcCallOptions &rhs) |
(since 6.8) QDebug | operator<<(QDebug debug, const QGrpcCallOptions &callOpts) |
(since 6.11) bool | operator==(const QGrpcCallOptions &lhs, const QGrpcCallOptions &rhs) |
Descripción detallada
QGrpcCallOptions permite personalizar llamadas a procedimientos remotos (RPC) individuales. La interfaz de cliente generada proporciona puntos de acceso para pasar los parámetros de QGrpcCallOptions. Estas opciones sustituyen a las establecidas mediante QGrpcChannelOptions.
Para configurar las opciones predeterminadas compartidas por las RPC, utiliza ` QGrpcChannelOptions`.
QGrpcCallOptions callOpts;
// Establecer los metadatos para una RPC concreta
callOpts.setMetadata({
{ "header" , "value1" },
{ "header" , "value2" },
});
const auto &md = callOpts.metadata(QtGrpc::MultiValue);
qDebug() << "Call Metadata: " << md;
// Establecer un tiempo de espera de 2 segundos para una llamada RPC individual
callOpts.setDeadlineTimeout(2s);
qDebug() << "Call timeout: " << callOpts.deadlineTimeout();Documentación sobre funciones de miembro
QGrpcCallOptions::QGrpcCallOptions()
Crea de forma predeterminada un objeto QGrpcCallOptions vacío.
QGrpcCallOptions::QGrpcCallOptions(const QGrpcCallOptions &other)
Crea un objeto `QGrpcCallOptions` a partir de ` other`.
[constexpr noexcept default] QGrpcCallOptions::QGrpcCallOptions(QGrpcCallOptions &&other)
Crea un nuevo objeto `QGrpcCallOptions` a partir de ` other`.
Nota: El objeto del que se ha realizado el traslado, ` other `, queda en un estado parcialmente formado, en el que las únicas operaciones válidas son la destrucción y la asignación de un nuevo valor.
[noexcept] QGrpcCallOptions::~QGrpcCallOptions()
Destruye el « QGrpcCallOptions ».
[since 6.10] QGrpcCallOptions &QGrpcCallOptions::addMetadata(QByteArrayView key, QByteArrayView value)
Añade key y value a metadata si aún no contiene ese par exacto. Una misma clave puede aparecer varias veces con valores diferentes.
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.
Nota: Los metadatosde la llamada se fusionan con cualquier metadato a nivel de canal cuando se inicia la RPC; véase QGrpcChannelOptions::addMetadata()
Esta función se introdujo en Qt 6.10.
Véase también metadata() y setMetadata().
[noexcept] std::optional<std::chrono::milliseconds> QGrpcCallOptions::deadlineTimeout() const
Devuelve la duración del tiempo de espera que se utiliza para calcular el plazo límite de las llamadas RPC.
Si este campo no está definido, devuelve un objeto ` std::optional` vacío.
Véase también setDeadlineTimeout().
[noexcept, since 6.11] std::optional<bool> QGrpcCallOptions::filterServerMetadata() const
Devuelve « true » si se excluyen del resultado los metadatos del servidor relacionados con el protocolo. Devuelve « false » para incluir todos los metadatos recibidos del servidor.
Si este campo no está definido, devuelve un ` std::optional` vacío.
Esta función se introdujo en Qt 6.11.
Véase también setFilterServerMetadata() y QGrpcChannelOptions::filterServerMetadata().
[since 6.12] std::optional<quint64> QGrpcCallOptions::maximumReceiveMessageSize() const
Devuelve el tamaño máximo permitido, en bytes, de un mensaje gRPC entrante. El límite se aplica a la carga útil de la trama gRPC descodificada, tras el descifrado a nivel de transporte y cualquier descompresión por mensaje.
Si no se especifica el valor, devuelve un objeto ` std::optional` vacío.
Por defecto, el valor no se especifica.
Nota: ` QGrpcHttp2Channel ` utiliza la variable de entorno ` QT_GRPC_MAXIMUM_RECEIVE_MESSAGE_SIZE ` como valor por defecto cuando esta opción no se establece explícitamente. Si la variable de entorno no está definida, se utiliza el valor por defecto integrado de ` 4 ` MiB. Véase l{Valores por defecto de las variables de entorno}.
Esta función se introdujo en Qt 6.12.
Véase también setMaximumReceiveMessageSize() y QGrpcChannelOptions::maximumReceiveMessageSize().
[until 6.13] QHash<QByteArray, QByteArray> QGrpcCallOptions::metadata() &&
[noexcept, until 6.13] const QHash<QByteArray, QByteArray> &QGrpcCallOptions::metadata() const &
Está previsto que esta función quede obsoleta en la versión 6.13.
Utiliza en su lugar la sobrecarga ` QMultiHash `.
Devuelve los metadatos. Si este campo no está definido, devuelve metadatos vacíos.
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.
Véase también setMetadata().
[since 6.10] QMultiHash<QByteArray, QByteArray> QGrpcCallOptions::metadata(QtGrpc::MultiValue_t) &&
[noexcept, since 6.10] const QMultiHash<QByteArray, QByteArray> &QGrpcCallOptions::metadata(QtGrpc::MultiValue_t) const &
Devuelve los metadatos. Si este campo no está definido, devuelve metadatos vacíos.
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 crear la solicitud. Algunos canales concretos pueden imponer restricciones adicionales; véase QGrpcHttp2Channel#Reserved metadata keys. Se admiten varios valores por clave.
const auto &md = opts.metadata(QtGrpc::MultiValue);Estas funciones se introdujeron en Qt 6.10.
Véase también setMetadata.
[since 6.12] std::optional<QtGrpc::CompressionAlgorithm> QGrpcCallOptions::requestCompression() const
Devuelve el algoritmo de compresión utilizado para comprimir los mensajes salientes en este canal o llamada.
Si este campo no está definido, devuelve un objeto ` std::optional` vacío.
Esta función se introdujo en Qt 6.12.
Véase también ` setRequestCompression()` y ` QGrpcChannelOptions::requestCompression()`.
QGrpcCallOptions &QGrpcCallOptions::setDeadlineTimeout(std::chrono::milliseconds timeout)
Establece el « timeout » y devuelve una referencia al objeto actualizado.
Un plazo establece el límite de tiempo que un cliente está dispuesto a esperar para recibir una respuesta del servidor. El plazo real se calcula sumando el « timeout » a la hora de inicio de la RPC.
El plazo de espera se aplica a toda la duración de una llamada RPC, lo que incluye la recepción del « QGrpcStatus » final de una llamada iniciada anteriormente y, por lo tanto, puede resultar indeseable para flujos (de larga duración).
Nota: Al configurar este campo se anula el campo de opciones de canal correspondiente; véase QGrpcChannelOptions::setDeadlineTimeout().
Véase también deadlineTimeout().
[since 6.11] QGrpcCallOptions &QGrpcCallOptions::setFilterServerMetadata(bool value)
Si value es true, se excluirán los metadatos relacionados con el protocolo definidos por el transporte gRPC (como las claves reservadas grpc- ). Si value es false, se incluirán todos los metadatos recibidos del servidor.
Nota: Al configurar este campo se anula el campo de opciones de canal correspondiente; véase QGrpcChannelOptions::setFilterServerMetadata()
Esta función se introdujo en Qt 6.11.
Véase también filterServerMetadata() y QGrpcChannelOptions::setFilterServerMetadata().
[since 6.12] QGrpcCallOptions &QGrpcCallOptions::setMaximumReceiveMessageSize(quint64 size)
Establece el tamaño máximo de los mensajes entrantes size en bytes y devuelve una referencia al objeto actualizado.
Los mensajes que superen este límite son rechazados con el código de error « StatusCode::ResourceExhausted » antes de que su carga útil se almacene en el búfer. El valor se utiliza tal cual, por lo que un ` size ` de ` 0 ` solo acepta mensajes vacíos.
Nota: Las implementacionesconcretas de los canales pueden imponer un límite máximo estricto al límite efectivo. El transporte QGrpcHttp2Channel limita el valor a la carga útil máxima de una trama gRPC sobre HTTP/2 (2^32 - 1) en bytes, o al máximo de qsizetype menos los 5 bytes de la cabecera de la trama gRPC en plataformas de 32 bits. Si se configura un valor mayor, se limitará a dicho tope.
Nota: Al configurar este campo se anula el campo de opciones de canal correspondiente; véase QGrpcChannelOptions::setMaximumReceiveMessageSize.
Esta función se introdujo en Qt 6.12.
Véase también maximumReceiveMessageSize() y QGrpcChannelOptions::setMaximumReceiveMessageSize().
[until 6.13] QGrpcCallOptions &QGrpcCallOptions::setMetadata(QHash<QByteArray, QByteArray> &&metadata)
[until 6.13] QGrpcCallOptions &QGrpcCallOptions::setMetadata(const QHash<QByteArray, QByteArray> &metadata)
Está previsto que esta función quede obsoleta en la versión 6.13.
Utiliza en su lugar la sobrecarga ` QMultiHash `.
Establece el ` metadata ` y devuelve una referencia al objeto actualizado.
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: Los metadatosde la llamada se fusionan con cualquier metadato a nivel de canal cuando se inicia la RPC; véase QGrpcChannelOptions::setMetadata(QMultiHash).
Véase también metadata().
[since 6.10] QGrpcCallOptions &QGrpcCallOptions::setMetadata(QMultiHash<QByteArray, QByteArray> &&metadata)
[since 6.10] QGrpcCallOptions &QGrpcCallOptions::setMetadata(const QMultiHash<QByteArray, QByteArray> &metadata)
[since 6.10] QGrpcCallOptions &QGrpcCallOptions::setMetadata(std::initializer_list<std::pair<QByteArray, QByteArray>> metadata)
Establece el valor de « metadata » y devuelve una referencia al objeto actualizado.
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. Se admiten varios valores por clave.
Nota: Los metadatosde la llamada se fusionan con cualquier metadato a nivel de canal cuando se inicia la RPC; véase QGrpcChannelOptions::setMetadata(QMultiHash).
Estas funciones se introdujeron en Qt 6.10.
Véase también metadata(QtGrpc::MultiValue_t).
[since 6.12] QGrpcCallOptions &QGrpcCallOptions::setRequestCompression(QtGrpc::CompressionAlgorithm algorithm)
Establece el algoritmo de compresión algorithm utilizado para comprimir los mensajes enviados por el cliente y devuelve una referencia al objeto actualizado.
Una vez establecido, el algoritmo se indica en el encabezado de solicitud « grpc-encoding ». Cada mensaje se comprime de forma independiente; si la compresión no reduce el tamaño de la carga útil, el mensaje se envía sin comprimir, con el parámetro « Compressed-Flag » establecido en « 0 » en cualquier caso.
Nota: La compresión de mensajes que contengan tanto datos confidenciales como datos que puedan verse potencialmente afectados por un atacante puede exponer la conexión a ataques de canal lateral de compresión, como CRIME o BREACH. Si es posible, evite comprimir este tipo de mensajes o separe los datos confidenciales y los no fiables en solicitudes diferentes.
Nota: Al configurar este campo se anula el campo de opciones de canal correspondiente.
Esta función se introdujo en Qt 6.12.
Véase también requestCompression() y QGrpcChannelOptions::setRequestCompression().
[noexcept, since 6.8] void QGrpcCallOptions::swap(QGrpcCallOptions &other)
Intercambia ` other ` con este objeto. Esta operación es muy rápida y nunca falla.
Esta función se introdujo en Qt 6.8.
[since 6.8] QGrpcCallOptions::operator QVariant() const
Crea un nuevo objeto ` QVariant ` a partir de este objeto.
Esta función se introdujo en Qt 6.8.
[noexcept] QGrpcCallOptions &QGrpcCallOptions::operator=(QGrpcCallOptions &&other)
La operación «move-assign» asigna other a este QGrpcCallOptions y devuelve una referencia al objeto actualizado.
Nota: El objeto del que se ha realizado el traslado, other, pasa a un estado parcialmente formado, en el que las únicas operaciones válidas son la destrucción y la asignación de un nuevo valor.
QGrpcCallOptions &QGrpcCallOptions::operator=(const QGrpcCallOptions &other)
Asigna ` other ` a este ` QGrpcCallOptions ` y devuelve una referencia al objeto actualizado.
Elementos no miembros relacionados
[noexcept, since 6.11] bool operator!=(const QGrpcCallOptions &lhs, const QGrpcCallOptions &rhs)
Devuelve ` true ` si los valores de ` deadlineTimeout`, ` filterServerMetadata`, ` maximumReceiveMessageSize`, ` requestCompression` y ` metadata` (QtGrpc::MultiValue_t) en ` lhs ` y ` rhs ` no son iguales.
Esta función se introdujo en Qt 6.11.
[since 6.8] QDebug operator<<(QDebug debug, const QGrpcCallOptions &callOpts)
Escribe « callOpts » en el flujo especificado « debug ».
Esta función se introdujo en Qt 6.8.
[noexcept, since 6.11] bool operator==(const QGrpcCallOptions &lhs, const QGrpcCallOptions &rhs)
Devuelve « true » si los valores de « deadlineTimeout », « filterServerMetadata », « maximumReceiveMessageSize », « requestCompression » y « metadata » (QtGrpc::MultiValue_t) en « lhs » y « rhs » son iguales.
Esta función se introdujo en Qt 6.11.
© 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.