GRPC C++  1.26.0
completion_queue.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2015-2016 gRPC authors.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18 
19 #ifndef GRPC_CORE_LIB_SURFACE_COMPLETION_QUEUE_H
20 #define GRPC_CORE_LIB_SURFACE_COMPLETION_QUEUE_H
21 
22 /* Internal API for completion queues */
23 
25 
26 #include <grpc/grpc.h>
27 
31 
32 /* These trace flags default to 1. The corresponding lines are only traced
33  if grpc_api_trace is also truthy */
38 
39 typedef struct grpc_cq_completion {
42 
44  void* tag;
47  void (*done)(void* done_arg, struct grpc_cq_completion* c);
48  void* done_arg;
50  uintptr_t next;
52 
53 #ifndef NDEBUG
54 void grpc_cq_internal_ref(grpc_completion_queue* cc, const char* reason,
55  const char* file, int line);
56 void grpc_cq_internal_unref(grpc_completion_queue* cc, const char* reason,
57  const char* file, int line);
58 #define GRPC_CQ_INTERNAL_REF(cc, reason) \
59  grpc_cq_internal_ref(cc, reason, __FILE__, __LINE__)
60 #define GRPC_CQ_INTERNAL_UNREF(cc, reason) \
61  grpc_cq_internal_unref(cc, reason, __FILE__, __LINE__)
62 #else
65 #define GRPC_CQ_INTERNAL_REF(cc, reason) grpc_cq_internal_ref(cc)
66 #define GRPC_CQ_INTERNAL_UNREF(cc, reason) grpc_cq_internal_unref(cc)
67 #endif
68 
69 /* Initializes global variables used by completion queues */
71 
72 /* Flag that an operation is beginning: the completion channel will not finish
73  shutdown until a corrensponding grpc_cq_end_* call is made.
74  \a tag is currently used only in debug builds. Return true on success, and
75  false if completion_queue has been shutdown. */
77 
78 /* Queue a GRPC_OP_COMPLETED operation; tag must correspond to the tag passed to
79  grpc_cq_begin_op */
81  void (*done)(void* done_arg, grpc_cq_completion* storage),
82  void* done_arg, grpc_cq_completion* storage,
83  bool internal = false);
84 
86 
88 
90 
92 
94  grpc_cq_completion_type completion_type, grpc_cq_polling_type polling_type,
96 
97 #endif /* GRPC_CORE_LIB_SURFACE_COMPLETION_QUEUE_H */
Definition: trace.h:61
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_polling_type
Completion queues internally MAY maintain a set of file descriptors in a structure called 'pollset'.
Definition: grpc_types.h:688
struct grpc_completion_queue grpc_completion_queue
Completion Queues enable notification of the completion of asynchronous actions.
Definition: grpc_types.h:56
struct grpc_pollset grpc_pollset
Definition: pollset.h:38
grpc_pollset * grpc_cq_pollset(grpc_completion_queue *cc)
void grpc_cq_internal_ref(grpc_completion_queue *cc, const char *reason, const char *file, int line)
int grpc_get_cq_poll_num(grpc_completion_queue *cc)
grpc_completion_queue * grpc_completion_queue_create_internal(grpc_cq_completion_type completion_type, grpc_cq_polling_type polling_type, grpc_experimental_completion_queue_functor *shutdown_callback)
void grpc_cq_end_op(grpc_completion_queue *cc, void *tag, grpc_error *error, void(*done)(void *done_arg, grpc_cq_completion *storage), void *done_arg, grpc_cq_completion *storage, bool internal=false)
grpc_core::TraceFlag grpc_cq_pluck_trace
grpc_cq_completion_type grpc_get_cq_completion_type(grpc_completion_queue *cc)
struct grpc_cq_completion grpc_cq_completion
void grpc_cq_global_init()
bool grpc_cq_begin_op(grpc_completion_queue *cc, void *tag)
grpc_core::DebugOnlyTraceFlag grpc_trace_cq_refcount
bool grpc_cq_can_listen(grpc_completion_queue *cc)
grpc_core::TraceFlag grpc_trace_operation_failures
grpc_core::DebugOnlyTraceFlag grpc_trace_pending_tags
void grpc_cq_internal_unref(grpc_completion_queue *cc, const char *reason, const char *file, int line)
Definition: completion_queue.h:39
uintptr_t next
next pointer; low bit is used to indicate success or not
Definition: completion_queue.h:50
void * done_arg
Definition: completion_queue.h:48
void(* done)(void *done_arg, struct grpc_cq_completion *c)
done callback - called when this queue element is no longer needed by the completion queue
Definition: completion_queue.h:47
grpc_core::ManualConstructor< grpc_core::MultiProducerSingleConsumerQueue > node
Definition: completion_queue.h:41
void * tag
user supplied tag
Definition: completion_queue.h:44
Definition: error_internal.h:39
EXPERIMENTAL: Specifies an interface class to be used as a tag for callback-based completion queues.
Definition: grpc_types.h:722