Qt GRPC Interceptors

For an introduction to the interception mechanism and how interceptor interfaces participate in the lifecycle of an RPC, see the Qt GRPC Interceptors Overview.

Qt GRPC provides the following interceptor interfaces as hook points in the RPC lifecycle:

InterfaceHook PointDirectionCan Modify
QGrpcStartInterceptorBefore the RPC is initiatedOutboundInitial message object, call options
QGrpcWriteMessageInterceptorBefore an outgoing message is writtenOutboundMessage object
QGrpcWritesDoneInterceptorWhen the client indicates writes are doneOutbound
QGrpcCancelInterceptorWhen the RPC is cancelledOutbound
QGrpcInitialMetadataInterceptorWhen initial metadata is receivedInboundMetadata
QGrpcMessageReceivedInterceptorWhen a message payload is receivedInboundSerialized message data
QGrpcTrailingMetadataInterceptorWhen trailing metadata is receivedInboundMetadata
QGrpcFinishedInterceptorWhen the RPC completesInboundFinal status

The following classes and pages form the Qt GRPC interceptor mechanism:

QGrpcCancelInterceptor

Intercepts cancellation requests for an RPC

QGrpcFinishedInterceptor

Intercepts the completion status of an RPC

QGrpcInitialMetadataInterceptor

Intercepts initial metadata for an RPC

QGrpcInterceptionContext

Provides contextual information to interceptor callbacks

QGrpcInterceptorChain

Stores and manages a sequence of interceptors

QGrpcMessageReceivedInterceptor

Intercepts incoming message payloads for an RPC

QGrpcStartInterceptor

Intercepts the start of an RPC

QGrpcTrailingMetadataInterceptor

Intercepts trailing metadata for an RPC

QGrpcWriteMessageInterceptor

Intercepts outgoing messages written for an RPC

QGrpcWritesDoneInterceptor

Intercepts the completion of message writes for an RPC

Qt GRPC Interceptors Overview

Provides an overview of the Qt GRPC interceptor mechanism.

QGrpcStartInterceptor::Continuation

Controls whether an intercepted RPC should proceed

InterceptorCapability

Specifies interception hook points supported by an interceptor

InterceptorCapabilities

A QFlags type that stores a combination of InterceptorCapability values

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