QGrpcOperationContext Class

成员函数文档

[override virtual noexcept] QGrpcOperationContext::~QGrpcOperationContext()

销毁操作上下文。

[noexcept] const QGrpcCallOptions &QGrpcOperationContext::callOptions() const &

返回该操作上下文所使用的调用选项。

有关全通道选项，请参阅QGrpcChannelOptions 。

[signal] void QGrpcOperationContext::cancelRequested()

当QGrpcOperation 请求取消通信时，会发出此信号。

通道应将其取消逻辑连接到此信号，并尝试取消 RPC，同时使用Cancelled 状态码结束该操作。无法保证取消操作一定成功。无需对从通道接收到的数据进行进一步处理，且应避免此类处理。

另请参阅 QGrpcOperation::cancel 。

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

返回此操作上下文对应的QtGrpc::RpcDescriptor 。

该函数在 Qt 6.11 中引入。

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

当 RPC 完成时，该通道应发出此信号。

这通常意味着服务器已针对请求的 RPC 发送了“status ”并关闭了连接。QAbstractGrpcChannel 的实现应检测到这种情况并发出该信号。

收到此信号后，不应再通过此操作上下文进行任何进一步的通信。客户端随后可以安全地删除相应的 RPC 对象。

另请参阅 QGrpcOperation::finished 。

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

当从服务器接收到了新的data 数据块时，该通道应发出此信号。

对于客户端流和单向调用，这意味着唯一的最终响应已到达，通信即将结束。

对于服务器和双向流，通道应在接收到每条新消息时持续发出此信号。

另请参阅 QGrpcServerStream::messageReceived 和QGrpcBidiStream::messageReceived 。

[noexcept] QLatin1StringView QGrpcOperationContext::method() const

返回与该操作上下文相关联的服务的名称。

[noexcept, since 6.11] quint64 QGrpcOperationContext::operationId() const

返回此操作上下文的唯一标识符。

在应用程序生命周期内，每个 ID 在所有通道中都是唯一的。

该函数于 Qt 6.11 版本中引入。

QMetaType QGrpcOperationContext::responseMetaType() const

返回 RPC 结果消息的元数据类型。

另请参阅 setResponseMetaType()。

std::shared_ptr<const QAbstractProtobufSerializer> QGrpcOperationContext::serializer() const

返回此操作上下文的序列化器

[noexcept, since 6.10] const QMultiHash<QByteArray, QByteArray> &QGrpcOperationContext::serverInitialMetadata() const &

返回在收到任何响应消息之前从服务器接收到的初始元数据。

初始元数据由服务器在呼叫建立后立即发送。它可能包含为该呼叫提供上下文信息的键值对。

该函数在 Qt 6.10 中引入。

另请参阅 setServerInitialMetadata()、QGrpcOperation::serverInitialMetadata() 和serverTrailingMetadata()。

[private signal, since 6.11] void QGrpcOperationContext::serverInitialMetadataReceived(const QMultiHash<QByteArray, QByteArray> &metadata)

当服务器返回其初始元数据时，会发出此信号。服务器的初始元数据会在 RPC 的初始响应之前发送给客户端。

接收到的元数据存储在metadata 中，也可通过serverInitialMetadata()获取。

该函数在 Qt 6.11 中引入。

另请参阅 QGrpcOperation::serverInitialMetadataReceived 和QGrpcBidiStream::writesDone 。

[noexcept, until 6.13] const QHash<QByteArray, QByteArray> &QGrpcOperationContext::serverMetadata() const &

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

请改用serverInitialMetadata() 和serverTrailingMetadata()。

返回在收到任何响应消息之前从服务器接收到的初始元数据。

初始元数据由服务器在呼叫建立后立即发送。它可能包含为该呼叫提供上下文的键值对。

另请参阅 setServerMetadata()、serverInitialMetadata() 和QGrpcOperation::serverInitialMetadata()。

[noexcept, since 6.10] const QMultiHash<QByteArray, QByteArray> &QGrpcOperationContext::serverTrailingMetadata() const &

返回在所有响应消息之后从服务器接收到的尾部元数据。

尾部元数据仅在所有响应消息发送完毕且 RPC 即将完成时由服务器发送。它可能包含键值对，用于提供有关已完成调用的额外上下文信息。

该函数在 Qt 6.10 中引入。

另请参阅 QGrpcOperation::serverTrailingMetadata() 和setServerTrailingMetadata()。

[noexcept] QLatin1StringView QGrpcOperationContext::service() const

返回与该操作上下文相关联的服务名称。

void QGrpcOperationContext::setResponseMetaType(QMetaType metaType)

存储RPC结果消息的metaType 。

另请参阅 responseMetaType()。

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

设置在 RPC 开始时从服务器接收的metadata 。

该函数自 Qt 6.10 起引入。

另请参阅 serverInitialMetadata()。

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

请改用setServerInitialMetadata()。

设置在 RPC 开始时从服务器接收到的元数据。

另请参阅 setServerInitialMetadata()。

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

设置在所有响应消息之后，从服务器接收到的尾部metadata 。

该函数在 Qt 6.10 中引入。

另请参阅 serverTrailingMetadata()。

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

当QGrpcClientStream 或QGrpcBidiStream 将data 序列化完毕，并准备通过通道进行传输时，会发出此信号。

通道应将其写入逻辑与该信号连接，并在将序列化数据写入传输线之前，将其封装在与通道相关的头部信息中。

另请参阅 QGrpcClientStream::writeMessage 和QGrpcBidiStream::writeMessage 。

[signal] void QGrpcOperationContext::writesDoneRequested()

该信号由 `QGrpcClientStream ` 或 `QGrpcBidiStream ` 发出，用于指示消息写入已完成。通道应对此作出响应，对流进行半关闭操作。

另请参阅 QGrpcClientStream::writesDone 和QGrpcBidiStream::writesDone 。