GRPC C++  1.26.0
Public Member Functions | Friends
grpc_impl::ServerContext Class Reference

A ServerContext or CallbackServerContext allows the code implementing a service handler to: More...

#include <server_context_impl.h>

Public Member Functions

 ServerContext ()
 
- Public Member Functions inherited from grpc_impl::ServerContextBase
virtual ~ServerContextBase ()
 
std::chrono::system_clock::time_point deadline () const
 Return the deadline for the server call. More...
 
gpr_timespec raw_deadline () const
 Return a gpr_timespec representation of the server call's deadline. More...
 
void AddInitialMetadata (const grpc::string &key, const grpc::string &value)
 Add the (key, value) pair to the initial metadata associated with a server call. More...
 
void AddTrailingMetadata (const grpc::string &key, const grpc::string &value)
 Add the (key, value) pair to the initial metadata associated with a server call. More...
 
bool IsCancelled () const
 IsCancelled is always safe to call when using sync or callback API. More...
 
void TryCancel () const
 Cancel the Call from the server. More...
 
const std::multimap< grpc::string_ref, grpc::string_ref > & client_metadata () const
 Return a collection of initial metadata key-value pairs sent from the client. More...
 
grpc_compression_level compression_level () const
 Return the compression algorithm to be used by the server call. More...
 
void set_compression_level (grpc_compression_level level)
 Set level to be the compression level used for the server call. More...
 
bool compression_level_set () const
 Return a bool indicating whether the compression level for this call has been set (either implicitly or through a previous call to set_compression_level. More...
 
grpc_compression_algorithm compression_algorithm () const
 Return the compression algorithm the server call will request be used. More...
 
void set_compression_algorithm (grpc_compression_algorithm algorithm)
 Set algorithm to be the compression algorithm used for the server call. More...
 
void SetLoadReportingCosts (const std::vector< grpc::string > &cost_data)
 Set the serialized load reporting costs in cost_data for the call. More...
 
std::shared_ptr< const ::grpc::AuthContextauth_context () const
 Return the authentication context for this server call. More...
 
grpc::string peer () const
 Return the peer uri in a string. More...
 
const struct census_context * census_context () const
 Get the census context associated with this server call. More...
 
grpc_callc_call ()
 Should be used for framework-level extensions only. More...
 

Friends

class ::grpc_impl::Server
 

Additional Inherited Members

- Protected Member Functions inherited from grpc_impl::ServerContextBase
void AsyncNotifyWhenDone (void *tag)
 Async only. More...
 
::grpc::experimental::RpcAllocatorStateGetRpcAllocatorState ()
 NOTE: This is an API for advanced users who need custom allocators. More...
 
::grpc_impl::ServerUnaryReactorDefaultReactor ()
 Get a library-owned default unary reactor for use in minimal reaction cases. More...
 
 ServerContextBase ()
 Constructors for use by derived classes. More...
 
 ServerContextBase (gpr_timespec deadline, grpc_metadata_array *arr)
 

Detailed Description

A ServerContext or CallbackServerContext allows the code implementing a service handler to:

Context settings are only relevant to the call handler they are supplied to, that is to say, they aren't sticky across multiple calls. Some of these settings, such as the compression options, can be made persistent at server construction time by specifying the appropriate ChannelArguments to a grpc::ServerBuilder, via ServerBuilder::AddChannelArgument.

Warning
ServerContext instances should not be reused across rpcs.

Constructor & Destructor Documentation

◆ ServerContext()

grpc_impl::ServerContext::ServerContext ( )
inline

Friends And Related Function Documentation

◆ ::grpc_impl::Server

friend class ::grpc_impl::Server
friend

The documentation for this class was generated from the following file: