GRPC Core  9.0.0
call.h
Go to the documentation of this file.
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 
23 
28 
29 #include <grpc/grpc.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 {
38 
40  uint32_t propagation_mask;
41 
43  /* if not NULL, it'll be used in lieu of cq */
45 
46  const void* server_transport_data;
47 
50 
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  */
58  grpc_call** call);
59 
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
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 
77 
79 
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. */
88 
89 /* Given the top call_element, get the call object. */
91 
92 void grpc_call_log_batch(const char* file, int line, gpr_log_severity severity,
93  const grpc_op* ops, size_t nops);
94 
95 /* Set a context pointer.
96  No thread safety guarantees are made wrt this value. */
97 /* TODO(#9731): add exec_ctx to destroy */
99  void* value, void (*destroy)(void* value));
100 /* Get a context pointer. */
102 
103 #define GRPC_CALL_LOG_BATCH(sev, ops, nops) \
104  do { \
105  if (GRPC_TRACE_FLAG_ENABLED(grpc_api_trace)) { \
106  grpc_call_log_batch(sev, ops, nops); \
107  } \
108  } while (0)
109 
110 uint8_t grpc_call_is_client(grpc_call* call);
111 
112 /* Get the estimated memory size for a call BESIDES the call stack. Combined
113  * with the size of the call stack, it helps estimate the arena size for the
114  * initial call. */
116 
117 /* Return an appropriate compression algorithm for the requested compression \a
118  * level in the context of \a call. */
120  grpc_call* call, grpc_compression_level level);
121 
124 
125 #endif /* GRPC_CORE_LIB_SURFACE_CALL_H */
void * grpc_call_context_get(grpc_call *call, grpc_context_index elem)
Definition: call.cc:1996
grpc_core::Arena * grpc_call_get_arena(grpc_call *call)
Definition: call.cc:1087
grpc_call_stack * grpc_call_get_call_stack(grpc_call *call)
Definition: call.cc:1089
void grpc_call_internal_ref(grpc_call *call, const char *reason)
Definition: call.cc:507
void grpc_call_set_completion_queue(grpc_call *call, grpc_completion_queue *cq)
Definition: call.cc:485
size_t grpc_call_get_initial_size_estimate()
Definition: call.cc:320
grpc_call_error grpc_call_start_batch_and_execute(grpc_call *call, const grpc_op *ops, size_t nops, grpc_closure *closure)
Definition: call.cc:1980
struct grpc_call_create_args grpc_call_create_args
grpc_core::TraceFlag grpc_call_error_trace
grpc_core::TraceFlag grpc_compression_trace
void grpc_call_log_batch(const char *file, int line, gpr_log_severity severity, const grpc_op *ops, size_t nops)
Definition: call_log_batch.cc:110
void(* grpc_ioreq_completion_func)(grpc_call *call, int success, void *user_data)
Definition: call.h:32
grpc_call * grpc_call_from_top_element(grpc_call_element *surface_element)
Definition: call.cc:650
grpc_error * grpc_call_create(const grpc_call_create_args *args, grpc_call **call)
Definition: call.cc:325
void grpc_call_cancel_internal(grpc_call *call)
Definition: call.cc:711
void grpc_call_context_set(grpc_call *call, grpc_context_index elem, void *value, void(*destroy)(void *value))
Definition: call.cc:1987
grpc_compression_algorithm grpc_call_compression_for_level(grpc_call *call, grpc_compression_level level)
Definition: call.cc:2002
uint8_t grpc_call_is_client(grpc_call *call)
Definition: call.cc:2000
void grpc_call_internal_unref(grpc_call *call, const char *reason)
Definition: call.cc:510
Definition: arena.h:44
Definition: trace.h:61
grpc_call_element * elem
Definition: client_channel.cc:112
grpc_compression_level
Compression levels allow a party with knowledge of its peer's accepted encodings to request compressi...
Definition: compression_types.h:71
grpc_compression_algorithm
The various compression algorithms supported by gRPC (not sorted by compression level)
Definition: compression_types.h:57
grpc_context_index
Call object context pointers.
Definition: context.h:27
int64_t grpc_millis
Definition: exec_ctx.h:35
grpc_call_error
Result of a grpc call.
Definition: grpc_types.h:407
gpr_log_severity
GPR log API.
Definition: log.h:43
struct grpc_pollset_set grpc_pollset_set
Definition: pollset_set.h:31
Definition: call.h:35
size_t add_initial_metadata_count
Definition: call.h:49
grpc_server * server
Definition: call.h:37
grpc_completion_queue * cq
Definition: call.h:42
uint32_t propagation_mask
Definition: call.h:40
grpc_pollset_set * pollset_set_alternative
Definition: call.h:44
grpc_mdelem * add_initial_metadata
Definition: call.h:48
grpc_millis send_deadline
Definition: call.h:51
const void * server_transport_data
Definition: call.h:46
grpc_call * parent
Definition: call.h:39
grpc_channel * channel
Definition: call.h:36
Definition: channel_stack.h:167
Definition: channel_stack.h:185
Definition: call.cc:134
Definition: channel.h:66
A closure over a grpc_iomgr_cb_func.
Definition: closure.h:56
Definition: completion_queue.cc:321
Definition: error_internal.h:39
Definition: metadata.h:98
Operation data: one field for each op type (except SEND_CLOSE_FROM_CLIENT which has no arguments)
Definition: grpc_types.h:590
Definition: server.cc:222