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_SRC_CORE_LIB_SURFACE_COMPLETION_QUEUE_H 20 #define GRPC_SRC_CORE_LIB_SURFACE_COMPLETION_QUEUE_H 21 22 // Internal API for completion queues 23 24 #include <grpc/grpc.h> 25 #include <grpc/support/port_platform.h> 26 #include <stdint.h> 27 28 #include "src/core/lib/iomgr/error.h" 29 #include "src/core/lib/iomgr/iomgr_fwd.h" 30 #include "src/core/util/manual_constructor.h" 31 #include "src/core/util/mpscq.h" 32 33 typedef struct grpc_cq_completion { 34 grpc_core::ManualConstructor< 35 grpc_core::MultiProducerSingleConsumerQueue::Node> 36 node; 37 38 /// user supplied tag 39 void* tag; 40 /// done callback - called when this queue element is no longer 41 /// needed by the completion queue 42 void (*done)(void* done_arg, struct grpc_cq_completion* c); 43 void* done_arg; 44 /// next pointer; low bit is used to indicate success or not 45 uintptr_t next; 46 } grpc_cq_completion; 47 48 #ifndef NDEBUG 49 void grpc_cq_internal_ref(grpc_completion_queue* cq, const char* reason, 50 const char* file, int line); 51 void grpc_cq_internal_unref(grpc_completion_queue* cq, const char* reason, 52 const char* file, int line); 53 #define GRPC_CQ_INTERNAL_REF(cq, reason) \ 54 grpc_cq_internal_ref(cq, reason, __FILE__, __LINE__) 55 #define GRPC_CQ_INTERNAL_UNREF(cq, reason) \ 56 grpc_cq_internal_unref(cq, reason, __FILE__, __LINE__) 57 #else 58 void grpc_cq_internal_ref(grpc_completion_queue* cq); 59 void grpc_cq_internal_unref(grpc_completion_queue* cq); 60 #define GRPC_CQ_INTERNAL_REF(cq, reason) grpc_cq_internal_ref(cq) 61 #define GRPC_CQ_INTERNAL_UNREF(cq, reason) grpc_cq_internal_unref(cq) 62 #endif 63 64 // Flag that an operation is beginning: the completion channel will not finish 65 // shutdown until a corresponding grpc_cq_end_* call is made. 66 // \a tag is currently used only in debug builds. Return true on success, and 67 // false if completion_queue has been shutdown. 68 bool grpc_cq_begin_op(grpc_completion_queue* cq, void* tag); 69 70 // Queue a GRPC_OP_COMPLETED operation; tag must correspond to the tag passed to 71 // grpc_cq_begin_op 72 void grpc_cq_end_op(grpc_completion_queue* cq, void* tag, 73 grpc_error_handle error, 74 void (*done)(void* done_arg, grpc_cq_completion* storage), 75 void* done_arg, grpc_cq_completion* storage, 76 bool internal = false); 77 78 grpc_pollset* grpc_cq_pollset(grpc_completion_queue* cq); 79 80 bool grpc_cq_can_listen(grpc_completion_queue* cq); 81 82 grpc_cq_completion_type grpc_get_cq_completion_type(grpc_completion_queue* cq); 83 84 int grpc_get_cq_poll_num(grpc_completion_queue* cq); 85 86 grpc_completion_queue* grpc_completion_queue_create_internal( 87 grpc_cq_completion_type completion_type, grpc_cq_polling_type polling_type, 88 grpc_completion_queue_functor* shutdown_callback); 89 90 #endif // GRPC_SRC_CORE_LIB_SURFACE_COMPLETION_QUEUE_H 91