#include <client_context.h>
grpc::ClientContext::ClientContext |
( |
| ) |
|
grpc::ClientContext::~ClientContext |
( |
| ) |
|
Add the (meta_key, meta_value) pair to the metadata associated with a client call.
These are made available at the server side by the grpc::ServerContext::client_metadata() method.
- Warning
- This method should only be called before invoking the rpc.
- Parameters
-
meta_key | The metadata key. If meta_value is binary data, it must end in "-bin". |
meta_value | The metadata value. If its value is binary, it must be base64-encoding (see https://tools.ietf.org/html/rfc4648#section-4) and meta_key must end in "-bin". |
std::shared_ptr<const AuthContext> grpc::ClientContext::auth_context |
( |
| ) |
const |
struct census_context* grpc::ClientContext::census_context |
( |
| ) |
const |
|
inline |
grpc_compression_algorithm grpc::ClientContext::compression_algorithm |
( |
| ) |
const |
|
inline |
Return the compression algorithm to be used by the client call.
std::chrono::system_clock::time_point grpc::ClientContext::deadline |
( |
| ) |
|
|
inline |
Return the deadline for the client call.
Create a new ClientContext as a child of an incoming server call, according to options (.
- See Also
- PropagationOptions).
- Parameters
-
server_context | The source server context to use as the basis for constructing the client context. |
options | The options controlling what to copy from the server_context. |
- Returns
- A newly constructed ClientContext instance based on server_context, with traits propagated (copied) according to options.
Return a collection of initial metadata key-value pairs.
Note that keys may happen more than once (ie, a std::multimap is returned).
- Warning
- This method should only be called after initial metadata has been received. For streaming calls, see ClientReaderInterface::WaitForInitialMetadata().
- Returns
- A multimap of initial metadata key-value pairs from the server.
Return a collection of trailing metadata key-value pairs.
Note that keys may happen more than once (ie, a std::multimap is returned).
- Warning
- This method is only callable once the stream has finished.
- Returns
- A multimap of metadata trailing key-value pairs from the server.
Return the peer uri in a string.
- Warning
- This value is never authenticated or subject to any security related code. It must not be used for any authentication related functionality. Instead, use auth_context.
- Returns
- The call's peer URI.
gpr_timespec grpc::ClientContext::raw_deadline |
( |
| ) |
|
|
inline |
Return a gpr_timespec representation of the client call's deadline.
void grpc::ClientContext::set_authority |
( |
const grpc::string & |
authority | ) |
|
|
inline |
void grpc::ClientContext::set_census_context |
( |
struct census_context * |
ccp | ) |
|
|
inline |
Get and set census context.
void grpc::ClientContext::set_compression_algorithm |
( |
grpc_compression_algorithm |
algorithm | ) |
|
Set algorithm to be the compression algorithm used for the client call.
- Parameters
-
algorith | The compression algorithm used for the client call. |
void grpc::ClientContext::set_credentials |
( |
const std::shared_ptr< Credentials > & |
creds | ) |
|
|
inline |
Set credentials for the client call.
A credentials object encapsulates all the state needed by a client to authenticate with a server and make various assertions, e.g., about the client’s identity, role, or whether it is authorized to make a particular call.
- See Also
- https://github.com/grpc/grpc/blob/master/doc/grpc-auth-support.md
template<typename T >
void grpc::ClientContext::set_deadline |
( |
const T & |
deadline | ) |
|
|
inline |
Set the deadline for the client call.
- Warning
- This method should only be called before invoking the rpc.
- Parameters
-
deadline | the deadline for the client call. Units are determined by the type used. |
void grpc::ClientContext::TryCancel |
( |
| ) |
|
Send a best-effort out-of-band cancel.
The call could be in any stage. e.g. if it is already finished, it may still return success.
There is no guarantee the call will be cancelled.
template<class R , class W >
template<class R , class W >
friend class ::grpc::testing::InteropClientContextInspector |
|
friend |
template<class InputMessage , class OutputMessage >
The documentation for this class was generated from the following file: