QGrpcChannelOptions Class

QGrpcChannelOptions 类为微调 gRPC 通道提供了各种选项。更多

头文件: #include <QGrpcChannelOptions>
CMake: find_package(Qt6 REQUIRED COMPONENTS Grpc)
target_link_libraries(mytarget PRIVATE Qt6::Grpc)
Qt 6.6
在 QML 中: GrpcChannelOptions

公共函数

QGrpcChannelOptions()
QGrpcChannelOptions(const QGrpcChannelOptions &other)
QGrpcChannelOptions(QGrpcChannelOptions &&other)
~QGrpcChannelOptions()
std::optional<std::chrono::milliseconds> deadlineTimeout() const
QHash<QByteArray, QByteArray> metadata() &&
const QHash<QByteArray, QByteArray> &metadata() const &
(since 6.8) QGrpcSerializationFormat serializationFormat() const
QGrpcChannelOptions &setDeadlineTimeout(std::chrono::milliseconds timeout)
QGrpcChannelOptions &setMetadata(QHash<QByteArray, QByteArray> &&metadata)
QGrpcChannelOptions &setMetadata(const QHash<QByteArray, QByteArray> &metadata)
(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) QVariant operator QVariant() const
QGrpcChannelOptions &operator=(QGrpcChannelOptions &&other)
QGrpcChannelOptions &operator=(const QGrpcChannelOptions &other)
(since 6.8) QDebug operator<<(QDebug debug, const QGrpcChannelOptions &chOpts)

详细说明

QGrpcChannelOptions 可让您自定义一个 gRPC通道。有些选项适用于在关联通道上操作的所有远程过程调用(RPC),该通道用于与服务通信。

使用 QGrcCallOptions 可覆盖特定 RPC 的选项。

注意: 这些选项的具体细节由通道的实现决定。

成员函数文档

QGrpcChannelOptions &QGrpcChannelOptions::setMetadata(QHash<QByteArray, QByteArray> &&metadata)

QGrpcChannelOptions &QGrpcChannelOptions::setMetadata(const QHash<QByteArray, QByteArray> &metadata)

设置通道的客户端metadata ,并返回更新对象的引用。

QGrpcHttp2Channel 将元数据转换成适当的 HTTP/2 标头,并添加到 HTTP/2 请求中。

注: 通过通道选项设置的元数据适用于在通道上运行的所有 RPC,但被QGrpcCallOptions::setMetadata() 覆盖的 RPC 除外。

QHash<QByteArray, QByteArray> QGrpcChannelOptions::metadata() &&

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

返回频道的客户端元数据。

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

QGrpcChannelOptions::QGrpcChannelOptions()

Default-构造一个空的 QGrpcChannelOptions。

QGrpcChannelOptions::QGrpcChannelOptions(const QGrpcChannelOptions &other)

other 复制-构建 QGrpcChannelOptions。

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

移动-从other 构建一个新的 QGrpcChannelOptions。

注: moved-from 对象other 处于部分形成状态,在这种状态下,唯一有效的操作是销毁和赋新值。

[noexcept] QGrpcChannelOptions::~QGrpcChannelOptions()

摧毁QGrpcChannelOptions.

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

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

如果未设置此字段,则返回空std::optional

另请参见 setDeadlineTimeout()。

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

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

如果未设置该字段,则返回Default 构建的序列化格式。

此函数在 Qt 6.8 中引入。

另请参阅 setSerializationFormat()。

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

为通道设置timeout ,并返回更新对象的引用。

截止时间设定了客户端愿意等待服务器响应的时间限制。实际的截止时间是通过将timeout 与 RPC 的开始时间相加来计算的。

截止时间适用于 RPC 的整个生命周期,包括接收先前启动的调用的最终QGrpcStatus ,因此对于(长生命周期的)数据流来说是不需要的。

注意: 通过通道选项设置的截止时间适用于在通道上运行的所有 RPC,但被 QGrpcCallOptions::setDeadline() 改写的 RPC 除外。

另请参阅 deadlineTimeout().

[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()。

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

与该对象交换other 。该操作速度非常快,而且不会失败。

此函数在 Qt 6.8 中引入。

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

从该对象构建一个新的QVariant

此函数在 Qt 6.8 中引入。

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

Move 将other 赋值给QGrpcChannelOptions ,并返回对更新对象的引用。

注意: 从移动对象other 将处于部分形成状态,在这种状态下,唯一有效的操作是销毁和分配新值。

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

other 指定为QGrpcChannelOptions ,并返回更新对象的引用。

相关非成员

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

chOpts 写入指定的流debug

该函数在 Qt 6.8 中引入。

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