Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
grpc::ServerCompletionQueue Class Reference

#include <completion_queue.h>

Inheritance diagram for grpc::ServerCompletionQueue:
Inheritance graph
[legend]

Public Member Functions

bool IsFrequentlyPolled ()
 
- Public Member Functions inherited from grpc::CompletionQueue
template<typename T >
NextStatus AsyncNext (void **tag, bool *ok, const T &deadline)
 
 CompletionQueue ()
 
 CompletionQueue (grpc_completion_queue *take)
 
grpc_completion_queuecq ()
 
template<typename T , typename F >
NextStatus DoThenAsyncNext (F &&f, void **tag, bool *ok, const T &deadline)
 
bool Next (void **tag, bool *ok)
 
void Shutdown ()
 
 ~CompletionQueue () override
 Destructor. Destroys the owned wrapped 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...
 

Private Member Functions

 ServerCompletionQueue (grpc_cq_completion_type completion_type, grpc_cq_polling_type polling_type, grpc_completion_queue_functor *shutdown_cb)
 

Private Attributes

grpc_cq_polling_type polling_type_
 

Friends

class grpc::Server
 
class grpc::ServerBuilder
 

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).

Definition at line 436 of file include/grpcpp/impl/codegen/completion_queue.h.

Constructor & Destructor Documentation

◆ ServerCompletionQueue() [1/2]

grpc::ServerCompletionQueue::ServerCompletionQueue ( )
inlineprotected

Default constructor.

Definition at line 442 of file include/grpcpp/impl/codegen/completion_queue.h.

◆ ServerCompletionQueue() [2/2]

grpc::ServerCompletionQueue::ServerCompletionQueue ( grpc_cq_completion_type  completion_type,
grpc_cq_polling_type  polling_type,
grpc_completion_queue_functor shutdown_cb 
)
inlineprivate
Parameters
completion_typeindicates whether this is a NEXT or CALLBACK completion queue.
polling_typeInforms the GRPC library about the type of polling allowed on this completion queue. See grpc_cq_polling_type's description in grpc_types.h for more details.
shutdown_cbis the shutdown callback used for CALLBACK api queues

Definition at line 451 of file include/grpcpp/impl/codegen/completion_queue.h.

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

Member Data Documentation

◆ polling_type_

grpc_cq_polling_type grpc::ServerCompletionQueue::polling_type_
private

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


grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:31