GRPC C++  1.24.0
Data Structures | Public Member Functions
grpc_impl::Alarm Class Reference

#include <alarm_impl.h>

Data Structures

class  experimental_type
 NOTE: class experimental_type is not part of the public API of this class TODO(vjpai): Move these contents to the public API of Alarm when they are no longer experimental. More...
 

Public Member Functions

 Alarm ()
 Create an unset completion queue alarm. More...
 
 ~Alarm ()
 Destroy the given completion queue alarm, cancelling it in the process. More...
 
template<typename T >
 Alarm (::grpc::CompletionQueue *cq, const T &deadline, void *tag)
 DEPRECATED: Create and set a completion queue alarm instance associated to cq. More...
 
template<typename T >
void Set (::grpc::CompletionQueue *cq, const T &deadline, void *tag)
 Trigger an alarm instance on completion queue cq at the specified time. More...
 
 Alarm (const Alarm &)=delete
 Alarms aren't copyable. More...
 
Alarmoperator= (const Alarm &)=delete
 
 Alarm (Alarm &&rhs)
 Alarms are movable. More...
 
Alarmoperator= (Alarm &&rhs)
 
void Cancel ()
 Cancel a completion queue alarm. More...
 
experimental_type experimental ()
 NOTE: The function experimental() is not stable public API. More...
 

Constructor & Destructor Documentation

◆ Alarm() [1/4]

grpc_impl::Alarm::Alarm ( )

Create an unset completion queue alarm.

◆ ~Alarm()

grpc_impl::Alarm::~Alarm ( )

Destroy the given completion queue alarm, cancelling it in the process.

◆ Alarm() [2/4]

template<typename T >
grpc_impl::Alarm::Alarm ( ::grpc::CompletionQueue cq,
const T &  deadline,
void *  tag 
)
inline

DEPRECATED: Create and set a completion queue alarm instance associated to cq.

This form is deprecated because it is inherently racy.

.

◆ Alarm() [3/4]

grpc_impl::Alarm::Alarm ( const Alarm )
delete

Alarms aren't copyable.

◆ Alarm() [4/4]

grpc_impl::Alarm::Alarm ( Alarm &&  rhs)
inline

Alarms are movable.

Member Function Documentation

◆ Cancel()

void grpc_impl::Alarm::Cancel ( )

Cancel a completion queue alarm.

Calling this function over an alarm that has already fired has no effect.

◆ experimental()

experimental_type grpc_impl::Alarm::experimental ( )
inline

NOTE: The function experimental() is not stable public API.

It is a view to the experimental components of this class. It may be changed or removed at any time.

◆ operator=() [1/2]

Alarm& grpc_impl::Alarm::operator= ( const Alarm )
delete

◆ operator=() [2/2]

Alarm& grpc_impl::Alarm::operator= ( Alarm &&  rhs)
inline

◆ Set()

template<typename T >
void grpc_impl::Alarm::Set ( ::grpc::CompletionQueue cq,
const T &  deadline,
void *  tag 
)
inline

Trigger an alarm instance on completion queue cq at the specified time.

Once the alarm expires (at deadline) or it's cancelled (see Cancel), an event with tag tag will be added to cq. If the alarm expired, the event's success bit will be true, false otherwise (ie, upon cancellation).


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