QGrpcChannelOptions Class

成员函数文档

QGrpcChannelOptions::QGrpcChannelOptions()

默认——构造一个空的 QGrpcChannelOptions 对象。

QGrpcChannelOptions::QGrpcChannelOptions(const QGrpcChannelOptions &other)

从other 复制并构造一个QGrpcChannelOptions对象。

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

从 `other` 移动构造一个新的 `QGrpcChannelOptions`。

[noexcept] QGrpcChannelOptions::~QGrpcChannelOptions()

销毁QGrpcChannelOptions 。

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

返回该通道愿意从服务器接受的压缩算法。该集合始终包含Identity ，因为gRPC 规范规定必须接受未压缩的消息。

该值用于构建grpc-accept-encoding 请求头。如果服务器响应的压缩算法不在此集合中，则调用将以Unimplemented 状态码结束。

默认情况下，此函数为supportedCompressionAlgorithms()：会声明当前 Qt 构建版本能够协商的所有算法。

该函数在 Qt 6.12 中引入。

另请参阅 setAcceptedCompressionAlgorithms() 和supportedCompressionAlgorithms()。

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

如果metadata 中尚未包含完全匹配的键值对，则将key 和value 添加到该列表中。同一键可以带有不同的值出现多次。

该函数在 Qt 6.10 中引入。

另请参阅 metadata() 和setMetadata()。

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

返回用于计算该通道截止时间的超时时长。

如果该字段未设置，则返回一个空的std::optional 。

另请参阅 setDeadlineTimeout()。

[noexcept, since 6.11] std::optional<bool> QGrpcChannelOptions::filterServerMetadata() const

如果结果中排除了与协议相关的服务器元数据，则返回true 。若要包含从服务器接收到的所有元数据，则返回false 。

如果未设置此字段，则返回一个空的std::optional 。

该函数于 Qt 6.11 中引入。

另请参阅 setFilterServerMetadata() 和QGrpcCallOptions::filterServerMetadata()。

[since 6.12] std::optional<quint64> QGrpcChannelOptions::maximumReceiveMessageSize() const

返回传入 gRPC 消息的最大允许大小（以字节为单位）。该限制适用于经过传输层解密和任何按消息进行的解压缩后的解码 gRPC 帧有效载荷。

如果未指定该值，则返回一个空的std::optional 。

默认情况下，该值未指定。

该函数在 Qt 6.12 中引入。

另请参阅 setMaximumReceiveMessageSize() 和QGrpcCallOptions::maximumReceiveMessageSize()。

该函数计划在 6.13 版本中被废弃。

请改用metadata （QtGrpc::MultiValue）。

返回元数据。如果该字段未设置，则返回空元数据。

另请参阅 metadata(QtGrpc::MultiValue_t) 和setMetadata()。

返回元数据。如果该字段未设置，则返回空元数据。

const auto &md = opts.metadata(QtGrpc::MultiValue);

这些函数于 Qt 6.10 中引入。

另请参阅 setMetadata 。

[since 6.12] std::optional<QtGrpc::CompressionAlgorithm> QGrpcChannelOptions::requestCompression() const

返回用于压缩该通道或呼叫中出站消息的压缩算法。

如果该字段未设置，则返回一个空的std::optional 。

该函数在 Qt 6.12 中引入。

另请参阅 setRequestCompression() 和QGrpcCallOptions::requestCompression()。

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

返回通道所使用的序列化格式。

如果该字段未设置，则返回一个由Default 构造的序列化格式。

该函数在 Qt 6.8 中引入。

另请参阅 setSerializationFormat()。

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

设置允许的压缩格式algorithms ，并返回更新后对象的引用。

Identity 该标志总是会被隐式添加，因为 gRPC 规范要求客户端接受未压缩的消息。

如果{QtGrpc::CompressionAlgorithm::Identity} 是唯一接受的算法，则会拒绝压缩响应。添加其他标志可允许服务器使用这些压缩算法进行响应。

只有该 Qt 构建版本支持且包含在algorithms 中的算法，才会作为可接受的响应压缩方法向服务器发布。supportedCompressionAlgorithms() 中不存在的标志将被静默丢弃。

该函数于 Qt 6.12 中引入。

另请参阅 acceptedCompressionAlgorithms() 和supportedCompressionAlgorithms()。

QGrpcChannelOptions &QGrpcChannelOptions::setDeadlineTimeout(std::chrono::milliseconds timeout)

设置timeout ，并返回更新后对象的引用。

超时时间限定了客户端愿意等待服务器响应的最长时间。实际超时时间是通过将timeout 与RPC的开始时间相加计算得出的。

该截止时间适用于 RPC 的整个生命周期，其中包括接收先前已启动调用的最终QGrpcStatus ，因此对于（长期运行的）流而言，这可能是不需要的。

另请参阅 deadlineTimeout()。

[since 6.11] QGrpcChannelOptions &QGrpcChannelOptions::setFilterServerMetadata(bool value)

如果 `value ` 的值为 `true`，则由 gRPC 传输层定义的与协议相关的元数据（例如保留的 `grpc- ` 键）将被排除。如果 `value ` 的值为 `false`，则将包含从服务器接收到的所有元数据。

该函数于 Qt 6.11 中引入。

另请参阅 filterServerMetadata() 和QGrpcCallOptions::setFilterServerMetadata()。

[since 6.12] QGrpcChannelOptions &QGrpcChannelOptions::setMaximumReceiveMessageSize(quint64 size)

设置传入消息的size 最大值（以字节为单位），并返回更新后对象的引用。

超过此限制的消息在有效负载被缓冲之前，会因StatusCode::ResourceExhausted 而被拒绝。该值将原样使用，因此size 的值设为0 时，仅接受空消息。

该函数在 Qt 6.12 中引入。

另请参阅 maximumReceiveMessageSize() 和QGrpcCallOptions::setMaximumReceiveMessageSize()。

该函数计划在 6.13 版本中被废弃。

请改用QMultiHash 的重载版本。

该函数用于设置metadata ，并返回更新后对象的引用。

另请参阅 metadata()。

设置metadata ，并返回更新后对象的引用。

这些函数在 Qt 6.10 中引入。

另请参阅 metadata(QtGrpc::MultiValue_t)。

[since 6.12] QGrpcChannelOptions &QGrpcChannelOptions::setRequestCompression(QtGrpc::CompressionAlgorithm algorithm)

设置用于压缩客户端发送的消息的压缩algorithm ，并返回更新后对象的引用。

设置后，该算法将在grpc-encoding 请求头中声明。每条消息均独立进行压缩；如果压缩无法减小有效载荷大小，则无论如何，该消息都将以未压缩的形式发送，此时Compressed-Flag 将设置为0 。

此函数在 Qt 6.12 中引入。

另请参阅 requestCompression() 和QGrpcCallOptions::setRequestCompression()。

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

为通道设置序列化format ，并返回更新后对象的引用。

该函数在 Qt 6.8 中引入。

另请参阅 serializationFormat()。

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

设置该通道的sslConfiguration ，并返回更新后对象的引用。

另请参阅 sslConfiguration()。

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

返回该通道的 SSL 配置。

如果未设置此字段，则返回一个空的 `std::optional`。

另请参阅 setSslConfiguration()。

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

返回当前 Qt 构建版本可协商的压缩算法。Identity 始终存在，因为gRPC 规范要求消息必须为未压缩格式。Deflate 和Gzip 始终受支持。

该函数在 Qt 6.12 中引入。

另请参阅 acceptedCompressionAlgorithms() 和setAcceptedCompressionAlgorithms()。

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

将 `other ` 与该对象进行交换。此操作速度极快，且绝不会失败。

该函数于 Qt 6.8 中引入。

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

根据该对象构建一个新的QVariant 。

该函数于 Qt 6.8 中引入。

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

将other 移入并赋值给此QGrpcChannelOptions ，并返回对更新后对象的引用。

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

将other 赋值给此QGrpcChannelOptions ，并返回更新后对象的引用。