GRPC C++  1.26.0
Public Member Functions
grpc::internal::CompletionQueueTag Class Referenceabstract

An interface allowing implementors to process and filter event tags. More...

#include <completion_queue_tag.h>

Public Member Functions

virtual ~CompletionQueueTag ()
 
virtual bool FinalizeResult (void **tag, bool *status)=0
 FinalizeResult must be called before informing user code that the operation bound to the underlying core completion queue tag has completed. More...
 

Detailed Description

An interface allowing implementors to process and filter event tags.

Constructor & Destructor Documentation

◆ ~CompletionQueueTag()

virtual grpc::internal::CompletionQueueTag::~CompletionQueueTag ( )
inlinevirtual

Member Function Documentation

◆ FinalizeResult()

virtual bool grpc::internal::CompletionQueueTag::FinalizeResult ( void **  tag,
bool *  status 
)
pure virtual

FinalizeResult must be called before informing user code that the operation bound to the underlying core completion queue tag has completed.

In practice, this means:

  1. For the sync API - before returning from Pluck
  2. For the CQ-based async API - before returning from Next
  3. For the callback-based API - before invoking the user callback

This is the method that translates from core-side tag/status to C++ API-observable tag/status.

The return value is the status of the operation (returning status is the general behavior of this function). If this function returns false, the tag is dropped and not returned from the completion queue: this concept is for events that are observed at core but not requested by the user application (e.g., server shutdown, for server unimplemented method responses, or for cases where a server-side RPC doesn't have a completion notification registered using AsyncNotifyWhenDone)

Implemented in grpc::internal::CallOpSet< Op1, Op2, Op3, Op4, Op5, Op6 >, grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpSendMessage, grpc::internal::CallOpServerSendStatus >, grpc::internal::CallOpSet< grpc::internal::CallOpRecvInitialMetadata >, grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpSendMessage, grpc::internal::CallOpClientSendClose >, grpc::internal::CallOpSet< grpc::internal::CallOpRecvInitialMetadata, grpc::internal::CallOpClientRecvStatus >, grpc::internal::CallOpSet< grpc::internal::CallOpRecvMessage< Response > >, grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata >, grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpSendMessage, grpc::internal::CallOpClientSendClose, grpc::internal::CallOpRecvInitialMetadata, grpc::internal::CallOpRecvMessage< R >, grpc::internal::CallOpClientRecvStatus >, grpc::internal::CallOpSet< grpc::internal::CallOpRecvMessage< R > >, grpc::internal::CallOpSet< grpc::internal::CallOpClientRecvStatus >, grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpServerSendStatus >, grpc::internal::CallOpSet< grpc::internal::CallOpRecvInitialMetadata, grpc::internal::CallOpGenericRecvMessage, grpc::internal::CallOpClientRecvStatus >, grpc::internal::CallOpSet< grpc::internal::CallOpRecvMessage< RequestType > >, grpc::internal::CallOpSet< grpc::internal::CallOpRecvInitialMetadata, grpc::internal::CallOpRecvMessage< R > >, grpc::internal::CallOpSet< grpc::internal::CallOpRecvMessage< R >, grpc::internal::CallOpClientRecvStatus >, grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpSendMessage, grpc::internal::CallOpClientSendClose, grpc::internal::CallOpRecvInitialMetadata >, grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpClientSendClose >, grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpRecvInitialMetadata >, grpc::internal::CallOpSet< grpc::internal::CallOpGenericRecvMessage, grpc::internal::CallOpClientRecvStatus >, grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpSendMessage >, grpc::ServerInterface::GenericAsyncRequest, grpc::ServerInterface::PayloadAsyncRequest< Message >, grpc::ServerInterface::RegisteredAsyncRequest, and grpc::ServerInterface::BaseAsyncRequest.


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