En esta página

QGrpcChannelOptions Class

La clase `QGrpcChannelOptions` ofrece diversas opciones para ajustar con precisión un canal gRPC. Más información...

Encabezado: #include <QGrpcChannelOptions>
CMake: find_package(Qt6 REQUIRED COMPONENTS Grpc)
target_link_libraries(mytarget PRIVATE Qt6::Grpc)
Desde: Qt 6.6
En QML: GrpcChannelOptions

Comparaciones de QGrpcChannelOptions

CategoríaTipos comparables
igualdadQGrpcChannelOptions

Funciones públicas

QGrpcChannelOptions()
QGrpcChannelOptions(const QGrpcChannelOptions &other)
QGrpcChannelOptions(QGrpcChannelOptions &&other)
~QGrpcChannelOptions()
(since 6.12) QtGrpc::CompressionAlgorithms acceptedCompressionAlgorithms() const
(since 6.10) QGrpcChannelOptions &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
(since 6.8) QGrpcSerializationFormat serializationFormat() const
(since 6.12) QGrpcChannelOptions &setAcceptedCompressionAlgorithms(QtGrpc::CompressionAlgorithms algorithms)
QGrpcChannelOptions &setDeadlineTimeout(std::chrono::milliseconds timeout)
(since 6.11) QGrpcChannelOptions &setFilterServerMetadata(bool value)
(since 6.12) QGrpcChannelOptions &setMaximumReceiveMessageSize(quint64 size)
(until 6.13) QGrpcChannelOptions &setMetadata(QHash<QByteArray, QByteArray> &&metadata)
(since 6.10) QGrpcChannelOptions &setMetadata(QMultiHash<QByteArray, QByteArray> &&metadata)
(until 6.13) QGrpcChannelOptions &setMetadata(const QHash<QByteArray, QByteArray> &metadata)
(since 6.10) QGrpcChannelOptions &setMetadata(const QMultiHash<QByteArray, QByteArray> &metadata)
(since 6.10) QGrpcChannelOptions &setMetadata(std::initializer_list<std::pair<QByteArray, QByteArray>> list)
(since 6.12) QGrpcChannelOptions &setRequestCompression(QtGrpc::CompressionAlgorithm algorithm)
(since 6.8) QGrpcChannelOptions &setSerializationFormat(const QGrpcSerializationFormat &format)
QGrpcChannelOptions &setSslConfiguration(const QSslConfiguration &sslConfiguration)
std::optional<QSslConfiguration> sslConfiguration() const
(since 6.8) void swap(QGrpcChannelOptions &other)
(since 6.8) operator QVariant() const
QGrpcChannelOptions &operator=(QGrpcChannelOptions &&other)
QGrpcChannelOptions &operator=(const QGrpcChannelOptions &other)

Miembros públicos estáticos

(since 6.12) QtGrpc::CompressionAlgorithms supportedCompressionAlgorithms()
(since 6.11) bool operator!=(const QGrpcChannelOptions &lhs, const QGrpcChannelOptions &rhs)
(since 6.8) QDebug operator<<(QDebug debug, const QGrpcChannelOptions &chOpts)
(since 6.11) bool operator==(const QGrpcChannelOptions &lhs, const QGrpcChannelOptions &rhs)

Descripción detallada

QGrpcChannelOptions te permite personalizar un gRPC™ canal. Algunas opciones se aplican a todas las llamadas a procedimientos remotos (RPC) que se ejecutan en el canal asociado, el cual se utiliza para comunicarse con los servicios.

Para anular opciones de RPC específicas, utiliza QGrpcCallOptions.

QGrpcChannelOptions channelOpts;
// Aplicar metadatos comunes a todas las RPC
channelOpts.setMetadata({
    { "header" , "value1" },
    { "header" , "value2" },
});
const auto &md = channelOpts.metadata(QtGrpc::MultiValue);
qDebug() << "Channel Metadata: " << md;

// Aplicar un tiempo de espera de 2 segundos a cada RPC
channelOpts.setDeadlineTimeout(2s);
qDebug() << "Channel timeout: " << channelOpts.deadlineTimeout();

// Configurar SSL/TLS
channelOpts.setSslConfiguration(QSslConfiguration());

Nota: Depende de la implementación del canal determinar los detalles de estas opciones.

Documentación de las funciones miembro

QGrpcChannelOptions::QGrpcChannelOptions()

Crea por defecto un objeto `QGrpcChannelOptions` vacío.

QGrpcChannelOptions::QGrpcChannelOptions(const QGrpcChannelOptions &other)

Crea un objeto `QGrpcChannelOptions` a partir de ` other`.

[constexpr noexcept default] QGrpcChannelOptions::QGrpcChannelOptions(QGrpcChannelOptions &&other)

Crea un nuevo objeto `QGrpcChannelOptions` a partir de ` other`.

Nota: El objeto del que se ha realizado la migración, ` 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] QGrpcChannelOptions::~QGrpcChannelOptions()

Destruye el « QGrpcChannelOptions ».

[since 6.12] QtGrpc::CompressionAlgorithms QGrpcChannelOptions::acceptedCompressionAlgorithms() const

Devuelve los algoritmos de compresión que este canal está dispuesto a aceptar del servidor. El conjunto siempre contiene « Identity », ya que la especificación « gRPC » exige que se acepten los mensajes sin comprimir.

El valor se utiliza para construir el encabezado de solicitud « grpc-accept-encoding ». Si el servidor responde con un algoritmo de compresión que no se encuentra en este conjunto, la llamada finaliza con un código de estado « Unimplemented ».

Por defecto, se trata de ` supportedCompressionAlgorithms()`: se anuncian todos los algoritmos que la compilación actual de Qt puede negociar.

Esta función se introdujo en Qt 6.12.

Véase también setAcceptedCompressionAlgorithms() y supportedCompressionAlgorithms().

[since 6.10] QGrpcChannelOptions &QGrpcChannelOptions::addMetadata(QByteArrayView key, QByteArrayView value)

Añade key y value a metadata si aún no contiene exactamente ese par. 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. Los canales concretos pueden imponer restricciones adicionales; véase QGrpcHttp2Channel#Reserved metadata keys.

Nota: Estos metadatos se incluyen en cada RPC realizada a través del canal. Los metadatos del canal se fusionan con cualquier metadato específico de la llamada cuando se inicia el RPC; véase QGrpcCallOptions::addMetadata()

Esta función se introdujo en Qt 6.10.

Véase también metadata() y setMetadata().

[noexcept] std::optional<std::chrono::milliseconds> QGrpcChannelOptions::deadlineTimeout() const

Devuelve la duración del tiempo de espera que se utiliza para calcular el plazo límite del canal.

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> QGrpcChannelOptions::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 objeto std::optional vacío.

Esta función se introdujo en Qt 6.11.

Véanse también setFilterServerMetadata() y QGrpcCallOptions::filterServerMetadata().

[since 6.12] std::optional<quint64> QGrpcChannelOptions::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 QGrpcCallOptions::maximumReceiveMessageSize().

[until 6.13] QHash<QByteArray, QByteArray> QGrpcChannelOptions::metadata() &&

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

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

Utiliza en su lugar ` metadata` (`QtGrpc::MultiValue`).

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. Los canales concretos pueden imponer restricciones adicionales; véase QGrpcHttp2Channel#Reserved metadata keys.

Véase también metadata(QtGrpc::MultiValue_t) y setMetadata().

[since 6.10] QMultiHash<QByteArray, QByteArray> QGrpcChannelOptions::metadata(QtGrpc::MultiValue_t) &&

[noexcept, since 6.10] const QMultiHash<QByteArray, QByteArray> &QGrpcChannelOptions::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 construir 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> QGrpcChannelOptions::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éanse también setRequestCompression() y QGrpcCallOptions::requestCompression().

[since 6.8] QGrpcSerializationFormat QGrpcChannelOptions::serializationFormat() const

Devuelve el formato de serialización utilizado por el canal.

Si este campo no está definido, devuelve un formato de serialización creado con ` Default `.

Esta función se introdujo en Qt 6.8.

Véase también setSerializationFormat().

[since 6.12] QGrpcChannelOptions &QGrpcChannelOptions::setAcceptedCompressionAlgorithms(QtGrpc::CompressionAlgorithms algorithms)

Establece el tipo de compresión aceptado algorithms y devuelve una referencia al objeto actualizado.

Identity Siempre se añade de forma implícita, ya que la especificación de gRPC exige que los clientes acepten mensajes sin comprimir.

Si {QtGrpc::CompressionAlgorithm::Identity} es el único algoritmo aceptado, se rechazan las respuestas comprimidas. Añadir indicadores adicionales permite al servidor responder utilizando esos algoritmos de compresión.

Solo los algoritmos compatibles con esta compilación de Qt e incluidos en algorithms se indican al servidor como métodos de compresión de respuesta aceptados. Los indicadores que no estén presentes en supportedCompressionAlgorithms() se descartan sin aviso.

Esta función se introdujo en Qt 6.12.

Véanse también acceptedCompressionAlgorithms() y supportedCompressionAlgorithms().

QGrpcChannelOptions &QGrpcChannelOptions::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 un RPC, lo que incluye la recepción del « QGrpcStatus » final de una llamada iniciada previamente y, por lo tanto, puede resultar indeseable para flujos (de larga duración).

Nota: La configuración de este campo se aplica a todas las RPC que operan en el canal, excepto aquellas anuladas por QGrpcCallOptions::setDeadlineTimeout().

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

[since 6.11] QGrpcChannelOptions &QGrpcChannelOptions::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: La configuración de este campo se aplica a todas las RPC que operan en el canal, excepto aquellas anuladas por QGrpcCallOptions::filterServerMetadata

Esta función se introdujo en Qt 6.11.

Véase también filterServerMetadata() y QGrpcCallOptions::setFilterServerMetadata().

[since 6.12] QGrpcChannelOptions &QGrpcChannelOptions::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. Cualquier valor configurado superior a este límite se ajustará a dicho límite máximo.

Nota: La configuración de este campo se aplica a todas las RPC que operan en el canal, excepto aquellas anuladas por ` QGrpcCallOptions::setMaximumReceiveMessageSize()`

Esta función se introdujo en Qt 6.12.

Véase también maximumReceiveMessageSize() y QGrpcCallOptions::setMaximumReceiveMessageSize().

[until 6.13] QGrpcChannelOptions &QGrpcChannelOptions::setMetadata(QHash<QByteArray, QByteArray> &&metadata)

[until 6.13] QGrpcChannelOptions &QGrpcChannelOptions::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 de ` 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 crear la solicitud. Los canales concretos pueden imponer restricciones adicionales; consulta QGrpcHttp2Channel#Reserved metadata keys.

Nota: Estos metadatos se incluyen en cada RPC realizada a través del canal. Los metadatos del canal se fusionan con cualquier metadato específico de la llamada cuando se inicia el RPC; véase QGrpcCallOptions::setMetadata(QMultiHash)

Véase también metadata().

[since 6.10] QGrpcChannelOptions &QGrpcChannelOptions::setMetadata(QMultiHash<QByteArray, QByteArray> &&metadata)

[since 6.10] QGrpcChannelOptions &QGrpcChannelOptions::setMetadata(const QMultiHash<QByteArray, QByteArray> &metadata)

[since 6.10] QGrpcChannelOptions &QGrpcChannelOptions::setMetadata(std::initializer_list<std::pair<QByteArray, QByteArray>> list)

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 utilicen estos prefijos 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: Estos metadatos se incluyen en cada RPC realizada a través del canal. Los metadatos del canal se fusionan con cualquier metadato específico de la llamada cuando se inicia el RPC; véase QGrpcCallOptions::setMetadata(QMultiHash)

Estas funciones se introdujeron en Qt 6.10.

Véase también metadata(QtGrpc::MultiValue_t).

[since 6.12] QGrpcChannelOptions &QGrpcChannelOptions::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 datos no fiables en solicitudes diferentes.

Nota: La configuración de este campo se aplica a todas las RPC que operan en el canal, excepto aquellas anuladas por QGrpcCallOptions::setRequestCompression()

Esta función se introdujo en Qt 6.12.

Véase también ` requestCompression()` y ` QGrpcCallOptions::setRequestCompression()`.

[since 6.8] QGrpcChannelOptions &QGrpcChannelOptions::setSerializationFormat(const QGrpcSerializationFormat &format)

Establece el ` format ` de serialización del canal y devuelve una referencia al objeto actualizado.

Esta función se introdujo en Qt 6.8.

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

QGrpcChannelOptions &QGrpcChannelOptions::setSslConfiguration(const QSslConfiguration &sslConfiguration)

Establece el objeto « sslConfiguration » para el canal y devuelve una referencia al objeto actualizado.

Véase también sslConfiguration().

std::optional<QSslConfiguration> QGrpcChannelOptions::sslConfiguration() const

Devuelve la configuración SSL del canal.

Si este campo no está definido, devuelve un objeto ` std::optional` vacío.

Véase también setSslConfiguration().

[static noexcept, since 6.12] QtGrpc::CompressionAlgorithms QGrpcChannelOptions::supportedCompressionAlgorithms()

Devuelve los algoritmos de compresión que la versión actual de Qt puede negociar. « Identity » siempre está presente, ya que la especificación « gRPC » exige que los mensajes no estén comprimidos. « Deflate » y « Gzip » siempre son compatibles.

Esta función se introdujo en Qt 6.12.

Véase también acceptedCompressionAlgorithms() y setAcceptedCompressionAlgorithms().

[noexcept, since 6.8] void QGrpcChannelOptions::swap(QGrpcChannelOptions &other)

Intercambia ` other ` por este objeto. Esta operación es muy rápida y nunca falla.

Esta función se introdujo en Qt 6.8.

[since 6.8] QGrpcChannelOptions::operator QVariant() const

Crea un nuevo objeto ` QVariant ` a partir de este objeto.

Esta función se introdujo en Qt 6.8.

[noexcept] QGrpcChannelOptions &QGrpcChannelOptions::operator=(QGrpcChannelOptions &&other)

La operación «move-assign» asigna other a este QGrpcChannelOptions 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.

QGrpcChannelOptions &QGrpcChannelOptions::operator=(const QGrpcChannelOptions &other)

Asigna ` other ` a este ` QGrpcChannelOptions ` y devuelve una referencia al objeto actualizado.

Elementos no miembros relacionados

[noexcept, since 6.11] bool operator!=(const QGrpcChannelOptions &lhs, const QGrpcChannelOptions &rhs)

Devuelve « true » si los valores de « acceptedCompressionAlgorithms », « deadlineTimeout », « filterServerMetadata », « maximumReceiveMessageSize », « metadata » (QtGrpc::MultiValue_t), « requestCompression », « serializationFormat » y « sslConfiguration » en « lhs » y « rhs » no son iguales.

Esta función se introdujo en Qt 6.11.

[since 6.8] QDebug operator<<(QDebug debug, const QGrpcChannelOptions &chOpts)

Escribe « chOpts » en el flujo especificado « debug ».

Esta función se introdujo en Qt 6.8.

[noexcept, since 6.11] bool operator==(const QGrpcChannelOptions &lhs, const QGrpcChannelOptions &rhs)

Devuelve ` true ` si los valores de ` acceptedCompressionAlgorithms`, ` deadlineTimeout`, ` filterServerMetadata`, ` maximumReceiveMessageSize`, ` metadata` (`QtGrpc::MultiValue_t`), ` requestCompression`, ` serializationFormat ` y ` sslConfiguration ` 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.