grpc::experimental::InterceptorBatchMethods Class Reference

Class that is passed as an argument to the Intercept method of the application's Interceptor interface implementation. More...

#include <interceptor.h>

Public Member Functions
virtual	~InterceptorBatchMethods ()
virtual bool	QueryInterceptionHookPoint (InterceptionHookPoints type)=0
	Determine whether the current batch has an interception hook point of type type. More...
virtual void	Proceed ()=0
	Signal that the interceptor is done intercepting the current batch of the RPC. More...
virtual void	Hijack ()=0
	Indicate that the interceptor has hijacked the RPC (only valid if the batch contains send_initial_metadata on the client side). More...
virtual ByteBuffer *	GetSendMessage ()=0
	Returns a modifable ByteBuffer holding the serialized form of the message that is going to be sent. More...
virtual std::multimap< grpc::string, grpc::string > *	GetSendInitialMetadata ()=0
	Returns a modifiable multimap of the initial metadata to be sent. More...
virtual Status	GetSendStatus ()=0
	Returns the status to be sent. Valid for PRE_SEND_STATUS interceptions. More...
virtual void	ModifySendStatus (const Status &status)=0
	Overwrites the status with status. More...
virtual std::multimap< grpc::string, grpc::string > *	GetSendTrailingMetadata ()=0
	Returns a modifiable multimap of the trailing metadata to be sent. More...
virtual void *	GetRecvMessage ()=0
	Returns a pointer to the modifiable received message. More...
virtual std::multimap< grpc::string_ref, grpc::string_ref > *	GetRecvInitialMetadata ()=0
	Returns a modifiable multimap of the received initial metadata. More...
virtual Status *	GetRecvStatus ()=0
	Returns a modifiable view of the received status on POST_RECV_STATUS interceptions; nullptr if not valid. More...
virtual std::multimap< grpc::string_ref, grpc::string_ref > *	GetRecvTrailingMetadata ()=0
	Returns a modifiable multimap of the received trailing metadata on POST_RECV_STATUS interceptions; nullptr if not valid. More...
virtual std::unique_ptr< ChannelInterface >	GetInterceptedChannel ()=0
	Gets an intercepted channel. More...

Detailed Description

Class that is passed as an argument to the Intercept method of the application's Interceptor interface implementation.

It has five purposes:

1. Indicate which hook points are present at a specific interception
2. Allow an interceptor to inform the library that an RPC should continue to the next stage of its processing (which may be another interceptor or the main path of the library)
3. Allow an interceptor to hijack the processing of the RPC (only for client-side RPCs with PRE_SEND_INITIAL_METADATA) so that it does not proceed with normal processing beyond that stage
4. Access the relevant fields of an RPC at each interception point
5. Set some fields of an RPC at each interception point, when possible

Constructor & Destructor Documentation

~InterceptorBatchMethods()

virtual grpc::experimental::InterceptorBatchMethods::~InterceptorBatchMethods ( )

inlinevirtual

Member Function Documentation

GetInterceptedChannel()

virtual std::unique_ptr<ChannelInterface> grpc::experimental::InterceptorBatchMethods::GetInterceptedChannel ( )

pure virtual

Gets an intercepted channel.

When a call is started on this interceptor, only interceptors after the current interceptor are created from the factory objects registered with the channel. This allows calls to be started from interceptors without infinite regress through the interceptor list.

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

GetRecvInitialMetadata()

virtual std::multimap<grpc::string_ref, grpc::string_ref>* grpc::experimental::InterceptorBatchMethods::GetRecvInitialMetadata ( )

pure virtual

Returns a modifiable multimap of the received initial metadata.

Valid for POST_RECV_INITIAL_METADATA interceptions; nullptr if not valid

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

GetRecvMessage()

virtual void* grpc::experimental::InterceptorBatchMethods::GetRecvMessage ( )

pure virtual

Returns a pointer to the modifiable received message.

Note that the message is already deserialized but the type is not set; the interceptor should static_cast to the appropriate type before using it. This is valid for POST_RECV_MESSAGE interceptions; nullptr for not valid

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

GetRecvStatus()

virtual Status* grpc::experimental::InterceptorBatchMethods::GetRecvStatus ( )

pure virtual

Returns a modifiable view of the received status on POST_RECV_STATUS interceptions; nullptr if not valid.

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

GetRecvTrailingMetadata()

virtual std::multimap<grpc::string_ref, grpc::string_ref>* grpc::experimental::InterceptorBatchMethods::GetRecvTrailingMetadata ( )

pure virtual

Returns a modifiable multimap of the received trailing metadata on POST_RECV_STATUS interceptions; nullptr if not valid.

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

GetSendInitialMetadata()

virtual std::multimap<grpc::string, grpc::string>* grpc::experimental::InterceptorBatchMethods::GetSendInitialMetadata ( )

pure virtual

Returns a modifiable multimap of the initial metadata to be sent.

Valid for PRE_SEND_INITIAL_METADATA interceptions. A value of nullptr indicates that this field is not valid.

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

GetSendMessage()

virtual ByteBuffer* grpc::experimental::InterceptorBatchMethods::GetSendMessage ( )

pure virtual

Returns a modifable ByteBuffer holding the serialized form of the message that is going to be sent.

Valid for PRE_SEND_MESSAGE interceptions. A return value of nullptr indicates that this ByteBuffer is not valid.

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

GetSendStatus()

virtual Status grpc::experimental::InterceptorBatchMethods::GetSendStatus ( )

pure virtual

Returns the status to be sent. Valid for PRE_SEND_STATUS interceptions.

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

GetSendTrailingMetadata()

virtual std::multimap<grpc::string, grpc::string>* grpc::experimental::InterceptorBatchMethods::GetSendTrailingMetadata ( )

pure virtual

Returns a modifiable multimap of the trailing metadata to be sent.

Valid for PRE_SEND_STATUS interceptions. A value of nullptr indicates that this field is not valid.

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

Hijack()

virtual void grpc::experimental::InterceptorBatchMethods::Hijack ( )

pure virtual

Indicate that the interceptor has hijacked the RPC (only valid if the batch contains send_initial_metadata on the client side).

Later interceptors in the interceptor list will not be called. Later batches on the same RPC will go through interception, but only up to the point of the hijacking interceptor.

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

ModifySendStatus()

virtual void grpc::experimental::InterceptorBatchMethods::ModifySendStatus ( const Status &  status )

pure virtual

Overwrites the status with status.

Valid for PRE_SEND_STATUS interceptions.

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

Proceed()

virtual void grpc::experimental::InterceptorBatchMethods::Proceed ( )

pure virtual

Signal that the interceptor is done intercepting the current batch of the RPC.

Every interceptor must either call Proceed or Hijack on each interception. In most cases, only Proceed will be used. Explicit use of Proceed is what enables interceptors to delay the processing of RPCs while they perform other work. Proceed is a no-op if the batch contains PRE_SEND_CANCEL. Simply returning from the Intercept method does the job of continuing the RPC in this case. This is because PRE_SEND_CANCEL is always in a separate batch and is not allowed to be delayed.

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

QueryInterceptionHookPoint()

virtual bool grpc::experimental::InterceptorBatchMethods::QueryInterceptionHookPoint ( InterceptionHookPoints  type )

pure virtual

Determine whether the current batch has an interception hook point of type type.

Implemented in grpc::internal::CancelInterceptorBatchMethods, and grpc::internal::InterceptorBatchMethodsImpl.

---

The documentation for this class was generated from the following file:

• include/grpcpp/impl/codegen/interceptor.h