GRPC C++  1.39.1
Public Member Functions
grpc::internal::AlarmImpl Class Reference

Public Member Functions

 AlarmImpl ()
 
 ~AlarmImpl () override
 
bool FinalizeResult (void **tag, bool *) override
 FinalizeResult must be called before informing user code that the operation bound to the underlying core completion queue tag has completed. More...
 
void Set (::grpc::CompletionQueue *cq, gpr_timespec deadline, void *tag)
 
void Set (gpr_timespec deadline, std::function< void(bool)> f)
 
void Cancel ()
 
void Destroy ()
 
- Public Member Functions inherited from grpc::internal::CompletionQueueTag
virtual ~CompletionQueueTag ()
 

Constructor & Destructor Documentation

◆ AlarmImpl()

grpc::internal::AlarmImpl::AlarmImpl ( )
inline

◆ ~AlarmImpl()

grpc::internal::AlarmImpl::~AlarmImpl ( )
inlineoverride

Member Function Documentation

◆ Cancel()

void grpc::internal::AlarmImpl::Cancel ( )
inline

◆ Destroy()

void grpc::internal::AlarmImpl::Destroy ( )
inline

◆ FinalizeResult()

bool grpc::internal::AlarmImpl::FinalizeResult ( void **  tag,
bool *  status 
)
inlineoverridevirtual

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)

Implements grpc::internal::CompletionQueueTag.

◆ Set() [1/2]

void grpc::internal::AlarmImpl::Set ( ::grpc::CompletionQueue cq,
gpr_timespec  deadline,
void *  tag 
)
inline

◆ Set() [2/2]

void grpc::internal::AlarmImpl::Set ( gpr_timespec  deadline,
std::function< void(bool)>  f 
)
inline

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