Go to the documentation of this file.
34 #ifndef GRPCPP_CLIENT_CONTEXT_H
35 #define GRPCPP_CLIENT_CONTEXT_H
61 class ServerContextBase;
62 class CallbackServerContext;
65 template <
class InputMessage,
class OutputMessage>
67 template <
class Request,
class Response>
69 template <
class Response>
71 template <
class Request>
74 class ClientContextAccessor;
82 template <
class W,
class R>
88 template <
class W,
class R>
94 class InteropClientContextInspector;
95 class ClientContextTestPeer;
100 template <
class InputMessage,
class OutputMessage>
104 class ServerContextImpl;
105 template <
class InputMessage,
class OutputMessage>
107 template <
class Request,
class Response>
109 template <
class Response>
111 template <
class Request>
114 class ClientContextAccessor;
237 void AddMetadata(
const std::string& meta_key,
const std::string& meta_value);
247 const std::multimap<grpc::string_ref, grpc::string_ref>&
250 return *recv_initial_metadata_.
map();
259 const std::multimap<grpc::string_ref, grpc::string_ref>&
262 return *trailing_metadata_.
map();
271 template <
typename T>
284 wait_for_ready_ = wait_for_ready;
285 wait_for_ready_explicitly_set_ =
true;
292 std::chrono::system_clock::time_point
deadline()
const {
301 void set_authority(
const std::string& authority) { authority_ = authority; }
308 if (auth_context_ ==
nullptr) {
311 return auth_context_;
324 void set_credentials(
const std::shared_ptr<grpc::CallCredentials>& creds);
331 std::shared_ptr<grpc::CallCredentials>
credentials() {
return creds_; }
337 return compression_algorithm_;
356 initial_metadata_corked_ = corked;
367 std::string
peer()
const;
429 template <
class W,
class R>
435 template <
class W,
class R>
440 template <
class InputMessage,
class OutputMessage>
442 template <
class InputMessage,
class OutputMessage>
444 template <
class Request,
class Response>
446 template <
class Response>
448 template <
class Request>
458 grpc_call* call()
const {
return call_; }
459 void set_call(
grpc_call* call,
const std::shared_ptr<grpc::Channel>& channel);
462 const char* method,
const char* suffix_for_stats,
464 const std::vector<std::unique_ptr<
466 size_t interceptor_pos) {
468 suffix_for_stats, channel);
469 rpc_info_.RegisterInterceptors(creators, interceptor_pos);
473 uint32_t initial_metadata_flags()
const {
475 (wait_for_ready_explicitly_set_
480 std::string authority() {
return authority_; }
482 void SendCancelToInterceptors();
484 static std::unique_ptr<ClientContext> FromInternalServerContext(
486 PropagationOptions options);
488 bool initial_metadata_received_;
489 bool wait_for_ready_;
490 bool wait_for_ready_explicitly_set_;
491 std::shared_ptr<grpc::Channel> channel_;
496 grpc::string authority_;
497 std::shared_ptr<grpc::CallCredentials> creds_;
498 mutable std::shared_ptr<const grpc::AuthContext> auth_context_;
500 std::multimap<std::string, std::string> send_initial_metadata_;
505 PropagationOptions propagation_options_;
508 bool initial_metadata_corked_;
510 std::string debug_error_string_;
517 #endif // GRPCPP_CLIENT_CONTEXT_H
Definition: client_callback.h:1111
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
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 (.
grpc_compression_algorithm compression_algorithm() const
Return the compression algorithm the client call will request be used.
Definition: client_context.h:336
void set_credentials(const std::shared_ptr< grpc::CallCredentials > &creds)
Set credentials for the client call.
Definition: client_context.h:68
Synchronous (blocking) client-side API for doing client-streaming RPCs, where the outgoing message st...
Definition: client_context.h:81
virtual void Destructor(ClientContext *context)=0
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm.h:33
void set_wait_for_ready(bool wait_for_ready)
Trigger wait-for-ready or not on this request.
Definition: client_context.h:283
Definition: server_context.h:613
void set_deadline(const T &deadline)
Set the deadline for the client call.
Definition: client_context.h:272
grpc_compression_algorithm
The various compression algorithms supported by gRPC (not sorted by compression level)
Definition: compression_types.h:60
virtual ~GlobalCallbacks()
Definition: client_context.h:398
Definition: client_context.h:101
Options for ClientContext::FromServerContext specifying which traits from the ServerContext to propag...
Definition: client_context.h:127
#define GPR_ASSERT(x)
abort() the process if x is zero, having written a line to the log.
Definition: log.h:95
Base class of ServerContext.
Definition: server_context.h:124
virtual void DefaultConstructor(ClientContext *context)=0
std::string peer() const
Return the peer uri in a string.
const std::multimap< grpc::string_ref, grpc::string_ref > & GetServerInitialMetadata() const
Return a collection of initial metadata key-value pairs.
Definition: client_context.h:248
gpr_timespec raw_deadline() const
Return a gpr_timespec representation of the client call's deadline.
Definition: client_context.h:297
PropagationOptions()
Definition: client_context.h:129
PropagationOptions & disable_census_stats_propagation()
Definition: client_context.h:146
void set_census_context(struct census_context *ccp)
Sets the census context.
Definition: client_context.h:373
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.
PropagationOptions & disable_census_tracing_propagation()
Definition: client_context.h:156
const std::multimap< grpc::string_ref, grpc::string_ref > & GetServerTrailingMetadata() const
Return a collection of trailing metadata key-value pairs.
Definition: client_context.h:260
Definition: client_interceptor.h:70
A call credentials object encapsulates the state needed by a client to authenticate with a server for...
Definition: credentials.h:123
#define GRPC_INITIAL_METADATA_WAIT_FOR_READY
Initial metadata flags.
Definition: grpc_types.h:200
Synchronous (blocking) client-side API for doing server-streaming RPCs, where the stream of messages ...
Definition: client_context.h:79
std::shared_ptr< const AuthContext > CreateAuthContext(grpc_call *call)
TODO(ctiller): not sure we want to make this a permanent thing.
#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:203
A ClientContext allows the person implementing a service client to:
Definition: client_context.h:193
PropagationOptions & disable_deadline_propagation()
Definition: client_context.h:136
Async API for client-side unary RPCs, where the message response received from the server is of type ...
Definition: client_context.h:91
struct grpc_call grpc_call
A Call represents an RPC.
Definition: grpc_types.h:70
void TryCancel()
Send a best-effort out-of-band cancel on the call associated with this client context.
friend class grpc::testing::ClientContextTestPeer
Definition: client_context.h:421
Definition: client_context.h:66
gpr_timespec raw_time()=delete
#define GRPC_PROPAGATE_CENSUS_STATS_CONTEXT
Propagate census context.
Definition: propagation_bits.h:35
Async client-side API for doing server-streaming RPCs, where the incoming message stream coming from ...
Definition: client_context.h:85
friend class grpc::testing::InteropClientContextInspector
Definition: client_context.h:420
Codegen interface for grpc::Channel.
Definition: channel_interface.h:71
static void SetGlobalCallbacks(GlobalCallbacks *callbacks)
Definition: async_unary_call.h:78
Definition: client_context.h:72
std::chrono::system_clock::time_point deadline() const
Return the deadline for the client call.
Definition: client_context.h:292
RpcType
Definition: rpc_method.h:31
PropagationOptions & enable_cancellation_propagation()
Definition: client_context.h:161
PropagationOptions & enable_deadline_propagation()
Definition: client_context.h:131
friend class grpc::internal::ClientContextAccessor
Definition: client_context.h:451
Async API on the client side for doing client-streaming RPCs, where the outgoing message stream going...
Definition: client_context.h:87
void set_fail_fast(bool fail_fast)
DEPRECATED: Use set_wait_for_ready() instead.
Definition: client_context.h:289
#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:45
uint32_t c_bitmask() const
Definition: client_context.h:171
Async client-side interface for bi-directional streaming, where the outgoing message stream going to ...
Definition: client_context.h:89
PropagationOptions & enable_census_tracing_propagation()
Definition: client_context.h:151
Definition: client_interceptor.h:47
void set_initial_metadata_corked(bool corked)
Flag whether the initial metadata should be corked.
Definition: client_context.h:355
#define GRPC_PROPAGATE_CENSUS_TRACING_CONTEXT
Definition: propagation_bits.h:36
Synchronous (blocking) client-side API for bi-directional streaming RPCs, where the outgoing message ...
Definition: client_context.h:83
Global Callbacks.
Definition: client_context.h:396
static std::unique_ptr< ClientContext > FromCallbackServerContext(const grpc::CallbackServerContext &server_context, PropagationOptions options=PropagationOptions())
Definition: call_op_set.h:769
A thin wrapper around grpc_completion_queue (see src/core/lib/surface/completion_queue....
Definition: completion_queue.h:103
Channels represent a connection to an endpoint. Created by CreateChannel.
Definition: channel.h:54
Definition: client_context.h:70
std::shared_ptr< const grpc::AuthContext > auth_context() const
Return the authentication context for the associated client call.
Definition: client_context.h:307
PropagationOptions & enable_census_stats_propagation()
Definition: client_context.h:141
PropagationOptions & disable_cancellation_propagation()
Definition: client_context.h:166
#define GRPC_PROPAGATE_DEADLINE
Propagation bits: this can be bitwise or-ed to form propagation_mask for grpc_call.
Definition: propagation_bits.h:33
Analogous to struct timespec.
Definition: time.h:48
std::shared_ptr< grpc::CallCredentials > credentials()
EXPERIMENTAL debugging API.
Definition: client_context.h:331
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:301
std::string debug_error_string() const
EXPERIMENTAL debugging API.
Definition: client_context.h:413
struct census_context * census_context() const
Returns the census context that has been set, or nullptr if not set.
Definition: client_context.h:376
std::chrono::system_clock::time_point Timespec2Timepoint(gpr_timespec t)
If you are trying to use CompletionQueue::AsyncNext with a time class that isn't either gpr_timespec ...
Definition: time.h:40
grpc_call * c_call()
Should be used for framework-level extensions only.
Definition: client_context.h:406
void set_compression_algorithm(grpc_compression_algorithm algorithm)
Set algorithm to be the compression algorithm used for the client call.
#define GRPC_PROPAGATE_CANCELLATION
Propagate cancellation.
Definition: propagation_bits.h:38