QGrpcOperationContext Class

メンバ関数のドキュメント

この関数はバージョン6.13で廃止予定である。

代わりにsetServerInitialMetadata() を使用してください。

RPC の開始時にサーバから受信したメタデータを設定します。

setServerInitialMetadata()も参照してください 。

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

操作コンテキストを破棄する。

[noexcept] QByteArrayView QGrpcOperationContext::argument() const

このoperation-contextが利用する直列化された引数を返します。

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

このoperation-contextが使用する呼オプションを返す。

チャネル全体のオプションについては、QGrpcChannelOptions を参照。

[signal] void QGrpcOperationContext::cancelRequested()

このシグナルは、通信のキャンセルを要求するときにQGrpcOperation 。

チャネルはキャンセル・ロジックをこのシグナルに接続し、RPCのキャンセルを試み、Cancelled ステータス・コードで終了することが期待される。キャンセルの成功は保証されない。チャネルから受信したデータをさらに処理することは要求されないので、避けるべきである。

QGrpcOperation::cancelも参照のこと 。

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

このシグナルは RPC が終了したときにチャネルから発行される。

これは通常、サーバーが要求された RPC に対してstatus を送信し、コネクションを閉じたことを意味する。QAbstractGrpcChannel の実装は、この状況を検出してシグナルを発するべきである。

このシグナルを受信した後は、この操作コンテキストを介した通信は行われない。クライアント側は、対応する RPC オブジェクトを安全に削除することができる。

QGrpcOperation::finishedも参照 。

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

このシグナルは、サーバーから新しいチャンク（data ）を受信 したときに、チャネルが発するべきである。

クライアントストリームと単項呼の場合、これは、1つの最終応答が到着し、 通信が終了しようとしていることを意味する。

サーバストリームや双方向ストリームの場合、このシグナルは、新しいメッセージを受信するたびに、チャネルから継続的に発信されなければならない。

QGrpcServerStream::messageReceived およびQGrpcBidiStream::messageReceivedも参照 。

[noexcept] QLatin1StringView QGrpcOperationContext::method() const

このoperation-contextに関連付けられているサービスのメソッド名を返します。

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()も参照してください 。

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

この関数はバージョン6.13で廃止予定である。

代わりにserverInitialMetadata() とserverTrailingMetadata() を使用してください。

応答メッセージの前に、サーバーから受け取った初期メタデータを返す。

初期メタデータは、呼の確立直後にサーバーから送られる。これには、呼のコンテキストを提供するkey-valueペアが含まれる。

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()も参照してください 。

[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も参照のこと 。