/* * * Copyright 2015 gRPC authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ #ifndef GRPC_CORE_LIB_SURFACE_CALL_H #define GRPC_CORE_LIB_SURFACE_CALL_H #include #include "src/core/lib/channel/channel_stack.h" #include "src/core/lib/channel/context.h" #include "src/core/lib/surface/api_trace.h" #include #include typedef void (*grpc_ioreq_completion_func)(grpc_call* call, int success, void* user_data); typedef struct grpc_call_create_args { grpc_channel* channel; grpc_server* server; grpc_call* parent; uint32_t propagation_mask; grpc_completion_queue* cq; /* if not NULL, it'll be used in lieu of cq */ grpc_pollset_set* pollset_set_alternative; const void* server_transport_data; grpc_mdelem* add_initial_metadata; size_t add_initial_metadata_count; grpc_millis send_deadline; } grpc_call_create_args; /* Create a new call based on \a args. Regardless of success or failure, always returns a valid new call into *call */ grpc_error* grpc_call_create(const grpc_call_create_args* args, grpc_call** call); void grpc_call_set_completion_queue(grpc_call* call, grpc_completion_queue* cq); #ifndef NDEBUG void grpc_call_internal_ref(grpc_call* call, const char* reason); void grpc_call_internal_unref(grpc_call* call, const char* reason); #define GRPC_CALL_INTERNAL_REF(call, reason) \ grpc_call_internal_ref(call, reason) #define GRPC_CALL_INTERNAL_UNREF(call, reason) \ grpc_call_internal_unref(call, reason) #else void grpc_call_internal_ref(grpc_call* call); void grpc_call_internal_unref(grpc_call* call); #define GRPC_CALL_INTERNAL_REF(call, reason) grpc_call_internal_ref(call) #define GRPC_CALL_INTERNAL_UNREF(call, reason) grpc_call_internal_unref(call) #endif gpr_arena* grpc_call_get_arena(grpc_call* call); grpc_call_stack* grpc_call_get_call_stack(grpc_call* call); grpc_call_error grpc_call_start_batch_and_execute(grpc_call* call, const grpc_op* ops, size_t nops, grpc_closure* closure); /* gRPC core internal version of grpc_call_cancel that does not create * exec_ctx. */ void grpc_call_cancel_internal(grpc_call* call); /* Given the top call_element, get the call object. */ grpc_call* grpc_call_from_top_element(grpc_call_element* surface_element); void grpc_call_log_batch(const char* file, int line, gpr_log_severity severity, grpc_call* call, const grpc_op* ops, size_t nops, void* tag); /* Set a context pointer. No thread safety guarantees are made wrt this value. */ /* TODO(#9731): add exec_ctx to destroy */ void grpc_call_context_set(grpc_call* call, grpc_context_index elem, void* value, void (*destroy)(void* value)); /* Get a context pointer. */ void* grpc_call_context_get(grpc_call* call, grpc_context_index elem); #define GRPC_CALL_LOG_BATCH(sev, call, ops, nops, tag) \ if (grpc_api_trace.enabled()) grpc_call_log_batch(sev, call, ops, nops, tag) uint8_t grpc_call_is_client(grpc_call* call); /* Get the estimated memory size for a call BESIDES the call stack. Combined * with the size of the call stack, it helps estimate the arena size for the * initial call. */ size_t grpc_call_get_initial_size_estimate(); /* Return an appropriate compression algorithm for the requested compression \a * level in the context of \a call. */ grpc_compression_algorithm grpc_call_compression_for_level( grpc_call* call, grpc_compression_level level); extern grpc_core::TraceFlag grpc_call_error_trace; extern grpc_core::TraceFlag grpc_compression_trace; #endif /* GRPC_CORE_LIB_SURFACE_CALL_H */