GRPC C++  1.43.1
Public Member Functions | Protected Member Functions | Friends
grpc::ServerCompletionQueue Class Reference

A specific type of completion queue used by the processing of notifications by servers. More...

#include <completion_queue.h>

Public Member Functions

bool IsFrequentlyPolled ()
 
- Public Member Functions inherited from grpc::CompletionQueue
 CompletionQueue ()
 Default constructor. More...
 
 CompletionQueue (grpc_completion_queue *take)
 Wrap take, taking ownership of the instance. More...
 
 ~CompletionQueue () override
 Destructor. Destroys the owned wrapped completion queue / instance. More...
 
bool Next (void **tag, bool *ok)
 Read from the queue, blocking until an event is available or the queue is shutting down. More...
 
template<typename T >
NextStatus AsyncNext (void **tag, bool *ok, const T &deadline)
 Read from the queue, blocking up to deadline (or the queue's shutdown). More...
 
template<typename T , typename F >
NextStatus DoThenAsyncNext (F &&f, void **tag, bool *ok, const T &deadline)
 EXPERIMENTAL First executes F, then reads from the queue, blocking up to deadline (or the queue's shutdown). More...
 
void Shutdown ()
 Request the shutdown of the queue. More...
 
grpc_completion_queuecq ()
 Returns a raw pointer to the underlying grpc_completion_queue instance. More...
 

Protected Member Functions

 ServerCompletionQueue ()
 Default constructor. More...
 
- Protected Member Functions inherited from grpc::CompletionQueue
 CompletionQueue (const grpc_completion_queue_attributes &attributes)
 Private constructor of CompletionQueue only visible to friend classes. More...
 

Friends

class ::grpc::ServerBuilder
 
class ::grpc::Server
 

Additional Inherited Members

- Public Types inherited from grpc::CompletionQueue
enum  NextStatus { SHUTDOWN, GOT_EVENT, TIMEOUT }
 Tri-state return for AsyncNext: SHUTDOWN, GOT_EVENT, TIMEOUT. More...
 

Detailed Description

A specific type of completion queue used by the processing of notifications by servers.

Instantiated by ServerBuilder or Server (for health checker).

Constructor & Destructor Documentation

◆ ServerCompletionQueue()

grpc::ServerCompletionQueue::ServerCompletionQueue ( )
inlineprotected

Default constructor.

Member Function Documentation

◆ IsFrequentlyPolled()

bool grpc::ServerCompletionQueue::IsFrequentlyPolled ( )
inline

Friends And Related Function Documentation

◆ ::grpc::Server

friend class ::grpc::Server
friend

◆ ::grpc::ServerBuilder

friend class ::grpc::ServerBuilder
friend

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