legacy-libs/grpc/deps/grpc/src/core/lib/surface/call.h

   1 /*
   2  *
   3  * Copyright 2015 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_CALL_H
  20 #define GRPC_CORE_LIB_SURFACE_CALL_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include "src/core/lib/channel/channel_stack.h"
  25 #include "src/core/lib/channel/context.h"
  26 #include "src/core/lib/gprpp/arena.h"
  27 #include "src/core/lib/surface/api_trace.h"
  28
  29 #include <grpc/grpc.h>
  30 #include <grpc/impl/codegen/compression_types.h>
  31
  32 typedef void (*grpc_ioreq_completion_func)(grpc_call* call, int success,
  33                                            void* user_data);
  34
  35 typedef struct grpc_call_create_args {
  36   grpc_channel* channel;
  37   grpc_server* server;
  38
  39   grpc_call* parent;
  40   uint32_t propagation_mask;
  41
  42   grpc_completion_queue* cq;
  43   /* if not NULL, it'll be used in lieu of cq */
  44   grpc_pollset_set* pollset_set_alternative;
  45
  46   const void* server_transport_data;
  47
  48   grpc_mdelem* add_initial_metadata;
  49   size_t add_initial_metadata_count;
  50
  51   grpc_millis send_deadline;
  52 } grpc_call_create_args;
  53
  54 /* Create a new call based on \a args.
  55    Regardless of success or failure, always returns a valid new call into *call
  56    */
  57 grpc_error* grpc_call_create(const grpc_call_create_args* args,
  58                              grpc_call** call);
  59
  60 void grpc_call_set_completion_queue(grpc_call* call, grpc_completion_queue* cq);
  61
  62 #ifndef NDEBUG
  63 void grpc_call_internal_ref(grpc_call* call, const char* reason);
  64 void grpc_call_internal_unref(grpc_call* call, const char* reason);
  65 #define GRPC_CALL_INTERNAL_REF(call, reason) \
  66   grpc_call_internal_ref(call, reason)
  67 #define GRPC_CALL_INTERNAL_UNREF(call, reason) \
  68   grpc_call_internal_unref(call, reason)
  69 #else
  70 void grpc_call_internal_ref(grpc_call* call);
  71 void grpc_call_internal_unref(grpc_call* call);
  72 #define GRPC_CALL_INTERNAL_REF(call, reason) grpc_call_internal_ref(call)
  73 #define GRPC_CALL_INTERNAL_UNREF(call, reason) grpc_call_internal_unref(call)
  74 #endif
  75
  76 grpc_core::Arena* grpc_call_get_arena(grpc_call* call);
  77
  78 grpc_call_stack* grpc_call_get_call_stack(grpc_call* call);
  79
  80 grpc_call_error grpc_call_start_batch_and_execute(grpc_call* call,
  81                                                   const grpc_op* ops,
  82                                                   size_t nops,
  83                                                   grpc_closure* closure);
  84
  85 /* gRPC core internal version of grpc_call_cancel that does not create
  86  * exec_ctx. */
  87 void grpc_call_cancel_internal(grpc_call* call);
  88
  89 /* Given the top call_element, get the call object. */
  90 grpc_call* grpc_call_from_top_element(grpc_call_element* surface_element);
  91
  92 void grpc_call_log_batch(const char* file, int line, gpr_log_severity severity,
  93                          grpc_call* call, const grpc_op* ops, size_t nops,
  94                          void* tag);
  95
  96 /* Set a context pointer.
  97    No thread safety guarantees are made wrt this value. */
  98 /* TODO(#9731): add exec_ctx to destroy */
  99 void grpc_call_context_set(grpc_call* call, grpc_context_index elem,
 100                            void* value, void (*destroy)(void* value));
 101 /* Get a context pointer. */
 102 void* grpc_call_context_get(grpc_call* call, grpc_context_index elem);
 103
 104 #define GRPC_CALL_LOG_BATCH(sev, call, ops, nops, tag) \
 105   do {                                                 \
 106     if (GRPC_TRACE_FLAG_ENABLED(grpc_api_trace)) {     \
 107       grpc_call_log_batch(sev, call, ops, nops, tag);  \
 108     }                                                  \
 109   } while (0)
 110
 111 uint8_t grpc_call_is_client(grpc_call* call);
 112
 113 /* Get the estimated memory size for a call BESIDES the call stack. Combined
 114  * with the size of the call stack, it helps estimate the arena size for the
 115  * initial call. */
 116 size_t grpc_call_get_initial_size_estimate();
 117
 118 /* Return an appropriate compression algorithm for the requested compression \a
 119  * level in the context of \a call. */
 120 grpc_compression_algorithm grpc_call_compression_for_level(
 121     grpc_call* call, grpc_compression_level level);
 122
 123 extern grpc_core::TraceFlag grpc_call_error_trace;
 124 extern grpc_core::TraceFlag grpc_compression_trace;
 125
 126 #endif /* GRPC_CORE_LIB_SURFACE_CALL_H */