34 #ifndef GRPCPP_IMPL_CODEGEN_CLIENT_CONTEXT_H
35 #define GRPCPP_IMPL_CODEGEN_CLIENT_CONTEXT_H
65 template <
class InputMessage,
class OutputMessage>
66 class CallbackUnaryCallImpl;
67 template <
class Request,
class Response>
68 class ClientCallbackReaderWriterImpl;
69 template <
class Response>
70 class ClientCallbackReaderImpl;
71 template <
class Request>
72 class ClientCallbackWriterImpl;
73 class ClientCallbackUnaryImpl;
74 class ClientContextAccessor;
75 class ClientAsyncResponseReaderHelper;
82 template <
class W,
class R>
83 class ClientReaderWriter;
85 class ClientAsyncReader;
87 class ClientAsyncWriter;
88 template <
class W,
class R>
89 class ClientAsyncReaderWriter;
91 class ClientAsyncResponseReader;
94 class InteropClientContextInspector;
95 class ClientContextTestPeer;
100 template <
class InputMessage,
class OutputMessage>
101 class BlockingUnaryCallImpl;
102 class CallOpClientRecvStatus;
103 class CallOpRecvInitialMetadata;
104 class ServerContextImpl;
105 template <
class InputMessage,
class OutputMessage>
106 class CallbackUnaryCallImpl;
107 template <
class Request,
class Response>
108 class ClientCallbackReaderWriterImpl;
109 template <
class Response>
110 class ClientCallbackReaderImpl;
111 template <
class Request>
112 class ClientCallbackWriterImpl;
113 class ClientCallbackUnaryImpl;
114 class ClientContextAccessor;
117 class CallCredentials;
119 class ChannelInterface;
120 class CompletionQueue;
232 void AddMetadata(
const std::string& meta_key,
const std::string& meta_value);
242 const std::multimap<grpc::string_ref, grpc::string_ref>&
245 return *recv_initial_metadata_.
map();
254 const std::multimap<grpc::string_ref, grpc::string_ref>&
257 return *trailing_metadata_.
map();
266 template <
typename T>
291 wait_for_ready_ = wait_for_ready;
292 wait_for_ready_explicitly_set_ =
true;
299 std::chrono::system_clock::time_point
deadline()
const {
308 void set_authority(
const std::string& authority) { authority_ = authority; }
315 if (auth_context_ ==
nullptr) {
318 return auth_context_;
338 std::shared_ptr<grpc::CallCredentials>
credentials() {
return creds_; }
344 return compression_algorithm_;
363 initial_metadata_corked_ = corked;
384 return census_context_;
426 friend class ::grpc::testing::InteropClientContextInspector;
427 friend class ::grpc::testing::ClientContextTestPeer;
428 friend class ::grpc::internal::CallOpClientRecvStatus;
429 friend class ::grpc::internal::CallOpRecvInitialMetadata;
430 friend class ::grpc::Channel;
432 friend class ::grpc::ClientReader;
434 friend class ::grpc::ClientWriter;
435 template <
class W,
class R>
436 friend class ::grpc::ClientReaderWriter;
438 friend class ::grpc::ClientAsyncReader;
440 friend class ::grpc::ClientAsyncWriter;
441 template <
class W,
class R>
442 friend class ::grpc::ClientAsyncReaderWriter;
444 friend class ::grpc::ClientAsyncResponseReader;
445 friend class ::grpc::internal::ClientAsyncResponseReaderHelper;
446 template <
class InputMessage,
class OutputMessage>
447 friend class ::grpc::internal::BlockingUnaryCallImpl;
448 template <
class InputMessage,
class OutputMessage>
449 friend class ::grpc::internal::CallbackUnaryCallImpl;
450 template <
class Request,
class Response>
451 friend class ::grpc::internal::ClientCallbackReaderWriterImpl;
452 template <
class Response>
453 friend class ::grpc::internal::ClientCallbackReaderImpl;
454 template <
class Request>
455 friend class ::grpc::internal::ClientCallbackWriterImpl;
456 friend class ::grpc::internal::ClientCallbackUnaryImpl;
457 friend class ::grpc::internal::ClientContextAccessor;
464 grpc_call* call()
const {
return call_; }
466 const std::shared_ptr<::grpc::Channel>& channel);
469 const char* method,
const char* suffix_for_stats,
471 const std::vector<std::unique_ptr<
473 size_t interceptor_pos) {
475 suffix_for_stats, channel);
476 rpc_info_.RegisterInterceptors(creators, interceptor_pos);
480 uint32_t initial_metadata_flags()
const {
484 (wait_for_ready_explicitly_set_
490 std::string authority() {
return authority_; }
492 void SendCancelToInterceptors();
494 static std::unique_ptr<ClientContext> FromInternalServerContext(
496 PropagationOptions options);
498 bool initial_metadata_received_;
499 bool wait_for_ready_;
500 bool wait_for_ready_explicitly_set_;
503 std::shared_ptr<::grpc::Channel> channel_;
508 grpc::string authority_;
509 std::shared_ptr<grpc::CallCredentials> creds_;
510 mutable std::shared_ptr<const grpc::AuthContext> auth_context_;
512 std::multimap<std::string, std::string> send_initial_metadata_;
517 PropagationOptions propagation_options_;
520 bool initial_metadata_corked_;
522 std::string debug_error_string_;
struct census_context census_context
A Census Context is a handle used by Census to represent the current tracing and stats collection inf...
Definition: census.h:34
Definition: server_context.h:578
Codegen interface for grpc::Channel.
Definition: channel_interface.h:71
Global Callbacks.
Definition: client_context.h:402
virtual void Destructor(ClientContext *context)=0
virtual ~GlobalCallbacks()
Definition: client_context.h:404
virtual void DefaultConstructor(ClientContext *context)=0
A ClientContext allows the person implementing a service client to:
Definition: client_context.h:193
const std::multimap< grpc::string_ref, grpc::string_ref > & GetServerInitialMetadata() const
Return a collection of initial metadata key-value pairs.
Definition: client_context.h:243
void set_credentials(const std::shared_ptr< grpc::CallCredentials > &creds)
Set credentials for the client call.
void set_cacheable(bool cacheable)
EXPERIMENTAL: Set this request to be cacheable.
Definition: client_context.h:282
void set_fail_fast(bool fail_fast)
DEPRECATED: Use set_wait_for_ready() instead.
Definition: client_context.h:296
gpr_timespec raw_deadline() const
Return a gpr_timespec representation of the client call's deadline.
Definition: client_context.h:304
static std::unique_ptr< ClientContext > FromServerContext(const grpc::ServerContextBase &server_context, PropagationOptions options=PropagationOptions())
Create a new ClientContext as a child of an incoming server call, according to options (.
void set_census_context(struct census_context *ccp)
Sets the census context.
Definition: client_context.h:380
const std::multimap< grpc::string_ref, grpc::string_ref > & GetServerTrailingMetadata() const
Return a collection of trailing metadata key-value pairs.
Definition: client_context.h:255
std::string peer() const
Return the peer uri in a string.
void set_compression_algorithm(grpc_compression_algorithm algorithm)
Set algorithm to be the compression algorithm used for the client call.
std::string debug_error_string() const
EXPERIMENTAL debugging API.
Definition: client_context.h:419
grpc_compression_algorithm compression_algorithm() const
Return the compression algorithm the client call will request be used.
Definition: client_context.h:343
void AddMetadata(const std::string &meta_key, const std::string &meta_value)
Add the (meta_key, meta_value) pair to the metadata associated with a client call.
std::shared_ptr< const grpc::AuthContext > auth_context() const
Return the authentication context for the associated client call.
Definition: client_context.h:314
std::chrono::system_clock::time_point deadline() const
Return the deadline for the client call.
Definition: client_context.h:299
grpc_call * c_call()
Should be used for framework-level extensions only.
Definition: client_context.h:412
struct census_context * census_context() const
Returns the census context that has been set, or nullptr if not set.
Definition: client_context.h:383
void set_wait_for_ready(bool wait_for_ready)
EXPERIMENTAL: Trigger wait-for-ready or not on this request.
Definition: client_context.h:290
void set_authority(const std::string &authority)
Set the per call authority header (see https://tools.ietf.org/html/rfc7540#section-8....
Definition: client_context.h:308
void TryCancel()
Send a best-effort out-of-band cancel on the call associated with this client context.
static void SetGlobalCallbacks(GlobalCallbacks *callbacks)
void set_deadline(const T &deadline)
Set the deadline for the client call.
Definition: client_context.h:267
std::shared_ptr< grpc::CallCredentials > credentials()
EXPERIMENTAL debugging API.
Definition: client_context.h:338
void set_initial_metadata_corked(bool corked)
Flag whether the initial metadata should be corked.
Definition: client_context.h:362
void set_idempotent(bool idempotent)
EXPERIMENTAL: Indicate that this request is idempotent.
Definition: client_context.h:277
static std::unique_ptr< ClientContext > FromCallbackServerContext(const grpc::CallbackServerContext &server_context, PropagationOptions options=PropagationOptions())
Options for ClientContext::FromServerContext specifying which traits from the ServerContext to propag...
Definition: client_context.h:127
PropagationOptions & disable_census_stats_propagation()
Definition: client_context.h:146
PropagationOptions & enable_census_tracing_propagation()
Definition: client_context.h:151
PropagationOptions & disable_cancellation_propagation()
Definition: client_context.h:166
PropagationOptions()
Definition: client_context.h:129
uint32_t c_bitmask() const
Definition: client_context.h:171
PropagationOptions & enable_deadline_propagation()
Definition: client_context.h:131
PropagationOptions & enable_cancellation_propagation()
Definition: client_context.h:161
PropagationOptions & disable_census_tracing_propagation()
Definition: client_context.h:156
PropagationOptions & enable_census_stats_propagation()
Definition: client_context.h:141
PropagationOptions & disable_deadline_propagation()
Definition: client_context.h:136
Base class of ServerContext. Experimental until callback API is final.
Definition: server_context.h:126
If you are trying to use CompletionQueue::AsyncNext with a time class that isn't either gpr_timespec ...
Definition: time.h:40
gpr_timespec raw_time()=delete
Definition: client_interceptor.h:46
Definition: client_interceptor.h:66
RpcType
Definition: rpc_method.h:31
grpc_compression_algorithm
The various compression algorithms supported by gRPC (not sorted by compression level)
Definition: compression_types.h:57
#define GRPC_INITIAL_METADATA_CORKED
Signal that the initial metadata should be corked.
Definition: grpc_types.h:508
struct grpc_call grpc_call
A Call represents an RPC.
Definition: grpc_types.h:70
#define GRPC_INITIAL_METADATA_IDEMPOTENT_REQUEST
Initial metadata flags.
Definition: grpc_types.h:499
#define GRPC_INITIAL_METADATA_CACHEABLE_REQUEST
Signal that the call is cacheable.
Definition: grpc_types.h:503
#define GRPC_INITIAL_METADATA_WAIT_FOR_READY
Signal that the call should not return UNAVAILABLE before it has started.
Definition: grpc_types.h:501
#define GRPC_INITIAL_METADATA_WAIT_FOR_READY_EXPLICITLY_SET
Signal that GRPC_INITIAL_METADATA_WAIT_FOR_READY was explicitly set by the calling application.
Definition: grpc_types.h:506
#define GPR_CODEGEN_ASSERT(x)
Codegen specific version of GPR_ASSERT.
Definition: core_codegen_interface.h:146
::grpc::ServerContextBase ServerContextBase
Definition: server_context.h:108
::grpc::CallbackServerContext CallbackServerContext
Definition: server_context.h:109
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm.h:33
std::chrono::system_clock::time_point Timespec2Timepoint(gpr_timespec t)
std::shared_ptr< const AuthContext > CreateAuthContext(grpc_call *call)
#define GRPC_PROPAGATE_CENSUS_STATS_CONTEXT
Propagate census context.
Definition: propagation_bits.h:33
#define GRPC_PROPAGATE_DEADLINE
Propagation bits: this can be bitwise or-ed to form propagation_mask for grpc_call.
Definition: propagation_bits.h:31
#define GRPC_PROPAGATE_CANCELLATION
Propagate cancellation.
Definition: propagation_bits.h:36
#define GRPC_PROPAGATE_DEFAULTS
Default propagation mask: clients of the core API are encouraged to encode deltas from this in their ...
Definition: propagation_bits.h:43
#define GRPC_PROPAGATE_CENSUS_TRACING_CONTEXT
Definition: propagation_bits.h:34
Analogous to struct timespec.
Definition: gpr_types.h:47