32 #ifndef GRPCPP_IMPL_CODEGEN_COMPLETION_QUEUE_IMPL_H
33 #define GRPCPP_IMPL_CODEGEN_COMPLETION_QUEUE_IMPL_H
53 template <
class W,
class R>
61 template <
class W,
class R>
62 class ServerReaderWriterBody;
64 template <
class ServiceType,
class RequestType,
class ResponseType>
66 template <
class ServiceType,
class RequestType,
class ResponseType>
68 template <
class ServiceType,
class RequestType,
class ResponseType>
70 template <
class Streamer,
bool WriteNeeded>
72 template <::grpc::StatusCode code>
78 class ChannelInterface;
79 class ServerInterface;
82 class CompletionQueueTag;
84 template <
class InputMessage,
class OutputMessage>
85 class BlockingUnaryCallImpl;
86 template <
class Op1,
class Op2,
class Op3,
class Op4,
class Op5,
class Op6>
175 bool Next(
void** tag,
bool* ok) {
176 return (AsyncNextInternal(tag, ok,
192 template <
typename T>
195 return AsyncNextInternal(tag, ok, deadline_tp.
raw_time());
212 template <
typename T,
typename F>
214 CompletionQueueTLSCache cache = CompletionQueueTLSCache(
this);
216 if (cache.Flush(tag, ok)) {
249 InitialAvalanching();
259 template <
class W,
class R>
265 template <
class W,
class R>
266 friend class ::grpc_impl::internal::ServerReaderWriterBody;
267 template <
class ServiceType,
class RequestType,
class ResponseType>
269 template <
class ServiceType,
class RequestType,
class ResponseType>
271 template <
class ServiceType,
class RequestType,
class ResponseType>
273 template <
class Streamer,
bool WriteNeeded>
275 template <::grpc::StatusCode code>
279 friend class ::grpc::ServerInterface;
280 template <
class InputMessage,
class OutputMessage>
281 friend class ::grpc::internal::BlockingUnaryCallImpl;
287 template <
class Op1,
class Op2,
class Op3,
class Op4,
class Op5,
class Op6>
288 friend class ::grpc::internal::CallOpSet;
294 class CompletionQueueTLSCache {
297 ~CompletionQueueTLSCache();
298 bool Flush(
void** tag,
bool* ok);
314 cq_, tag, deadline,
nullptr);
336 cq_, tag, deadline,
nullptr);
352 cq_, tag, deadline,
nullptr);
368 void InitialAvalanching() {
371 void RegisterAvalanching() {
375 void CompleteAvalanching() {
377 static_cast<gpr_atm>(-1)) == 1) {
410 polling_type_(polling_type) {}
Interface between the codegen library and the minimal subset of core features required by the generat...
Definition: core_codegen_interface.h:38
virtual void grpc_completion_queue_destroy(grpc_completion_queue *cq)=0
virtual grpc_event grpc_completion_queue_pluck(grpc_completion_queue *cq, void *tag, gpr_timespec deadline, void *reserved)=0
virtual void grpc_completion_queue_shutdown(grpc_completion_queue *cq)=0
virtual gpr_timespec gpr_inf_future(gpr_clock_type type)=0
virtual gpr_timespec gpr_time_0(gpr_clock_type type)=0
virtual grpc_completion_queue * grpc_completion_queue_create(const grpc_completion_queue_factory *factory, const grpc_completion_queue_attributes *attributes, void *reserved)=0
Classes that require gRPC to be initialized should inherit from this class.
Definition: grpc_library.h:38
If you are trying to use CompletionQueue::AsyncNext with a time class that isn't either gpr_timespec ...
Definition: time.h:40
gpr_timespec raw_time()
Definition: time.h:43
An interface allowing implementors to process and filter event tags.
Definition: completion_queue_tag.h:26
virtual bool FinalizeResult(void **tag, bool *status)=0
FinalizeResult must be called before informing user code that the operation bound to the underlying c...
A thin wrapper around grpc_completion_queue (see src/core/lib/surface/completion_queue....
Definition: completion_queue_impl.h:100
NextStatus
Tri-state return for AsyncNext: SHUTDOWN, GOT_EVENT, TIMEOUT.
Definition: completion_queue_impl.h:120
@ GOT_EVENT
Got a new event; tag will be filled in with its associated value; ok indicating its success.
Definition: completion_queue_impl.h:122
@ TIMEOUT
deadline was reached.
Definition: completion_queue_impl.h:124
@ SHUTDOWN
The completion queue has been shutdown and fully-drained.
Definition: completion_queue_impl.h:121
CompletionQueue()
Default constructor.
Definition: completion_queue_impl.h:104
NextStatus AsyncNext(void **tag, bool *ok, const T &deadline)
Read from the queue, blocking up to deadline (or the queue's shutdown).
Definition: completion_queue_impl.h:193
CompletionQueue(const grpc_completion_queue_attributes &attributes)
Private constructor of CompletionQueue only visible to friend classes.
Definition: completion_queue_impl.h:244
void Shutdown()
Request the shutdown of the queue.
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 shu...
Definition: completion_queue_impl.h:213
~CompletionQueue()
Destructor. Destroys the owned wrapped completion queue / instance.
Definition: completion_queue_impl.h:115
grpc_completion_queue * cq()
Returns a raw pointer to the underlying grpc_completion_queue instance.
Definition: completion_queue_impl.h:240
CompletionQueue(grpc_completion_queue *take)
Wrap take, taking ownership of the instance.
bool Next(void **tag, bool *ok)
Read from the queue, blocking until an event is available or the queue is shutting down.
Definition: completion_queue_impl.h:175
A specific type of completion queue used by the processing of notifications by servers.
Definition: completion_queue_impl.h:389
ServerCompletionQueue()
Default constructor.
Definition: completion_queue_impl.h:395
bool IsFrequentlyPolled()
Definition: completion_queue_impl.h:391
@ GPR_CLOCK_REALTIME
Realtime clock.
Definition: gpr_types.h:36
GPRAPI gpr_timespec gpr_inf_future(gpr_clock_type type)
The zero time interval.
GRPCAPI const grpc_completion_queue_factory * grpc_completion_queue_factory_lookup(const grpc_completion_queue_attributes *attributes)
Returns the completion queue factory based on the attributes.
grpc_cq_completion_type
Specifies the type of APIs to use to pop events from the completion queue.
Definition: grpc_types.h:706
@ GRPC_CQ_NEXT
Events are popped out by calling grpc_completion_queue_next() API ONLY.
Definition: grpc_types.h:708
#define GRPC_CQ_CURRENT_VERSION
Definition: grpc_types.h:740
grpc_cq_polling_type
Completion queues internally MAY maintain a set of file descriptors in a structure called 'pollset'.
Definition: grpc_types.h:688
@ GRPC_CQ_NON_LISTENING
Similar to GRPC_CQ_DEFAULT_POLLING except that the completion queues will not contain any 'listening ...
Definition: grpc_types.h:696
@ GRPC_CQ_DEFAULT_POLLING
The completion queue will have an associated pollset and there is no restriction on the type of file ...
Definition: grpc_types.h:691
struct grpc_completion_queue grpc_completion_queue
Completion Queues enable notification of the completion of asynchronous actions.
Definition: grpc_types.h:56
@ GRPC_QUEUE_TIMEOUT
No event before timeout.
Definition: grpc_types.h:506
@ GRPC_QUEUE_SHUTDOWN
Shutting down.
Definition: grpc_types.h:504
#define GPR_CODEGEN_ASSERT(x)
Codegen specific version of GPR_ASSERT.
Definition: core_codegen_interface.h:146
intptr_t gpr_atm
Definition: atm_gcc_atomic.h:30
#define gpr_atm_rel_store(p, value)
Definition: atm_gcc_atomic.h:52
#define gpr_atm_no_barrier_fetch_add(p, delta)
Definition: atm_gcc_atomic.h:57
::grpc_impl::ServerContextBase ServerContextBase
Definition: server_context.h:30
::grpc_impl::internal::ServerStreamingHandler< ServiceType, RequestType, ResponseType > ServerStreamingHandler
Definition: method_handler.h:46
::grpc_impl::internal::RpcMethodHandler< ServiceType, RequestType, ResponseType > RpcMethodHandler
Definition: method_handler.h:36
::grpc_impl::internal::ErrorMethodHandler< code > ErrorMethodHandler
Definition: method_handler.h:62
::grpc_impl::internal::TemplatedBidiStreamingHandler< Streamer, WriteNeeded > TemplatedBidiStreamingHandler
Definition: method_handler.h:50
::grpc_impl::internal::ClientStreamingHandler< ServiceType, RequestType, ResponseType > ClientStreamingHandler
Definition: method_handler.h:41
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm_impl.h:33
This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInp...
Definition: alarm.h:24
::grpc_impl::Server Server
Definition: server.h:26
::grpc_impl::Channel Channel
Definition: channel.h:26
::grpc_impl::ClientReader< R > ClientReader
Definition: sync_stream.h:56
::grpc_impl::ClientWriter< W > ClientWriter
Definition: sync_stream.h:62
::grpc_impl::ServerReader< R > ServerReader
Definition: sync_stream.h:75
::grpc_impl::ServerBuilder ServerBuilder
Definition: server_builder.h:26
::grpc_impl::ClientReaderWriter< W, R > ClientReaderWriter
Definition: sync_stream.h:69
CoreCodegenInterface * g_core_codegen_interface
Definition: completion_queue_impl.h:90
::grpc_impl::ServerWriter< W > ServerWriter
Definition: sync_stream.h:81
Analogous to struct timespec.
Definition: gpr_types.h:47
Definition: grpc_types.h:742
int success
If the grpc_completion_type is GRPC_OP_COMPLETE, this field indicates whether the operation was succe...
Definition: grpc_types.h:522
EXPERIMENTAL: Specifies an interface class to be used as a tag for callback-based completion queues.
Definition: grpc_types.h:722