GRPC C++  1.26.0
Public Member Functions
grpc::internal::CancelInterceptorBatchMethods Class Reference

#include <interceptor_common.h>

Public Member Functions

bool QueryInterceptionHookPoint (experimental::InterceptionHookPoints type) override
 Determine whether the current batch has an interception hook point of type type. More...
 
void Proceed () override
 Signal that the interceptor is done intercepting the current batch of the RPC. More...
 
void Hijack () override
 Indicate that the interceptor has hijacked the RPC (only valid if the batch contains send_initial_metadata on the client side). More...
 
ByteBufferGetSerializedSendMessage () override
 Send Message Methods GetSerializedSendMessage and GetSendMessage/ModifySendMessage are the available methods to view and modify the request payload. More...
 
bool GetSendMessageStatus () override
 Checks whether the SEND MESSAGE op succeeded. More...
 
const void * GetSendMessage () override
 Returns a non-modifiable pointer to the non-serialized form of the message to be sent. More...
 
void ModifySendMessage (const void *) override
 Overwrites the message to be sent with message. More...
 
std::multimap< grpc::string, grpc::string > * GetSendInitialMetadata () override
 Returns a modifiable multimap of the initial metadata to be sent. More...
 
Status GetSendStatus () override
 Returns the status to be sent. Valid for PRE_SEND_STATUS interceptions. More...
 
void ModifySendStatus (const Status &) override
 Overwrites the status with status. More...
 
std::multimap< grpc::string, grpc::string > * GetSendTrailingMetadata () override
 Returns a modifiable multimap of the trailing metadata to be sent. More...
 
void * GetRecvMessage () override
 Returns a pointer to the modifiable received message. More...
 
std::multimap< grpc::string_ref, grpc::string_ref > * GetRecvInitialMetadata () override
 Returns a modifiable multimap of the received initial metadata. More...
 
StatusGetRecvStatus () override
 Returns a modifiable view of the received status on PRE_RECV_STATUS and POST_RECV_STATUS interceptions; nullptr if not valid. More...
 
std::multimap< grpc::string_ref, grpc::string_ref > * GetRecvTrailingMetadata () override
 Returns a modifiable multimap of the received trailing metadata on PRE_RECV_STATUS and POST_RECV_STATUS interceptions; nullptr if not valid. More...
 
std::unique_ptr< ChannelInterfaceGetInterceptedChannel () override
 Gets an intercepted channel. More...
 
void FailHijackedRecvMessage () override
 On a hijacked RPC, an interceptor can decide to fail a PRE_RECV_MESSAGE op. More...
 
void FailHijackedSendMessage () override
 On a hijacked RPC/ to-be hijacked RPC, this can be called to fail a SEND MESSAGE op. More...
 
- Public Member Functions inherited from grpc::experimental::InterceptorBatchMethods
virtual ~InterceptorBatchMethods ()
 

Member Function Documentation

◆ FailHijackedRecvMessage()

void grpc::internal::CancelInterceptorBatchMethods::FailHijackedRecvMessage ( )
inlineoverridevirtual

On a hijacked RPC, an interceptor can decide to fail a PRE_RECV_MESSAGE op.

This would be a signal to the reader that there will be no more messages, or the stream has failed or been cancelled.

Implements grpc::experimental::InterceptorBatchMethods.

◆ FailHijackedSendMessage()

void grpc::internal::CancelInterceptorBatchMethods::FailHijackedSendMessage ( )
inlineoverridevirtual

On a hijacked RPC/ to-be hijacked RPC, this can be called to fail a SEND MESSAGE op.

Implements grpc::experimental::InterceptorBatchMethods.

◆ GetInterceptedChannel()

std::unique_ptr<ChannelInterface> grpc::internal::CancelInterceptorBatchMethods::GetInterceptedChannel ( )
inlineoverridevirtual

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.

Implements grpc::experimental::InterceptorBatchMethods.

◆ GetRecvInitialMetadata()

std::multimap<grpc::string_ref, grpc::string_ref>* grpc::internal::CancelInterceptorBatchMethods::GetRecvInitialMetadata ( )
inlineoverridevirtual

Returns a modifiable multimap of the received initial metadata.

Valid for PRE_RECV_INITIAL_METADATA and POST_RECV_INITIAL_METADATA interceptions; nullptr if not valid

Implements grpc::experimental::InterceptorBatchMethods.

◆ GetRecvMessage()

void* grpc::internal::CancelInterceptorBatchMethods::GetRecvMessage ( )
inlineoverridevirtual

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 PRE_RECV_MESSAGE and POST_RECV_MESSAGE interceptions; nullptr for not valid

Implements grpc::experimental::InterceptorBatchMethods.

◆ GetRecvStatus()

Status* grpc::internal::CancelInterceptorBatchMethods::GetRecvStatus ( )
inlineoverridevirtual

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

Implements grpc::experimental::InterceptorBatchMethods.

◆ GetRecvTrailingMetadata()

std::multimap<grpc::string_ref, grpc::string_ref>* grpc::internal::CancelInterceptorBatchMethods::GetRecvTrailingMetadata ( )
inlineoverridevirtual

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

Implements grpc::experimental::InterceptorBatchMethods.

◆ GetSendInitialMetadata()

std::multimap<grpc::string, grpc::string>* grpc::internal::CancelInterceptorBatchMethods::GetSendInitialMetadata ( )
inlineoverridevirtual

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.

Implements grpc::experimental::InterceptorBatchMethods.

◆ GetSendMessage()

const void* grpc::internal::CancelInterceptorBatchMethods::GetSendMessage ( )
inlineoverridevirtual

Returns a non-modifiable pointer to the non-serialized form of the message to be sent.

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

Implements grpc::experimental::InterceptorBatchMethods.

◆ GetSendMessageStatus()

bool grpc::internal::CancelInterceptorBatchMethods::GetSendMessageStatus ( )
inlineoverridevirtual

Checks whether the SEND MESSAGE op succeeded.

Valid for POST_SEND_MESSAGE interceptions.

Implements grpc::experimental::InterceptorBatchMethods.

◆ GetSendStatus()

Status grpc::internal::CancelInterceptorBatchMethods::GetSendStatus ( )
inlineoverridevirtual

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

Implements grpc::experimental::InterceptorBatchMethods.

◆ GetSendTrailingMetadata()

std::multimap<grpc::string, grpc::string>* grpc::internal::CancelInterceptorBatchMethods::GetSendTrailingMetadata ( )
inlineoverridevirtual

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.

Implements grpc::experimental::InterceptorBatchMethods.

◆ GetSerializedSendMessage()

ByteBuffer* grpc::internal::CancelInterceptorBatchMethods::GetSerializedSendMessage ( )
inlineoverridevirtual

Send Message Methods GetSerializedSendMessage and GetSendMessage/ModifySendMessage are the available methods to view and modify the request payload.

An interceptor can access the payload in either serialized form or non-serialized form but not both at the same time. gRPC performs serialization in a lazy manner, which means that a call to GetSerializedSendMessage will result in a serialization operation if the payload stored is not in the serialized form already; the non-serialized form will be lost and GetSendMessage will no longer return a valid pointer, and this will remain true for later interceptors too. This can change however if ModifySendMessage is used to replace the current payload. Note that ModifySendMessage requires a new payload message in the non-serialized form. This will overwrite the existing payload irrespective of whether it had been serialized earlier. Also note that gRPC Async API requires early serialization of the payload which means that the payload would be available in the serialized form only unless an interceptor replaces the payload with ModifySendMessage. 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.

Implements grpc::experimental::InterceptorBatchMethods.

◆ Hijack()

void grpc::internal::CancelInterceptorBatchMethods::Hijack ( )
inlineoverridevirtual

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.

Implements grpc::experimental::InterceptorBatchMethods.

◆ ModifySendMessage()

void grpc::internal::CancelInterceptorBatchMethods::ModifySendMessage ( const void *  message)
inlineoverridevirtual

Overwrites the message to be sent with message.

message should be in the non-serialized form expected by the method. Valid for PRE_SEND_MESSAGE interceptions. Note that the interceptor is responsible for maintaining the life of the message till it is serialized or it receives the POST_SEND_MESSAGE interception point, whichever happens earlier. The modifying interceptor may itself force early serialization by calling GetSerializedSendMessage.

Implements grpc::experimental::InterceptorBatchMethods.

◆ ModifySendStatus()

void grpc::internal::CancelInterceptorBatchMethods::ModifySendStatus ( const Status status)
inlineoverridevirtual

Overwrites the status with status.

Valid for PRE_SEND_STATUS interceptions.

Implements grpc::experimental::InterceptorBatchMethods.

◆ Proceed()

void grpc::internal::CancelInterceptorBatchMethods::Proceed ( )
inlineoverridevirtual

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.

Implements grpc::experimental::InterceptorBatchMethods.

◆ QueryInterceptionHookPoint()

bool grpc::internal::CancelInterceptorBatchMethods::QueryInterceptionHookPoint ( experimental::InterceptionHookPoints  type)
inlineoverridevirtual

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

Implements grpc::experimental::InterceptorBatchMethods.


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