A ServerContext allows the person implementing a service handler to: More...

#include <server_context_impl.h>

Public Member Functions
	ServerContext ()

	~ServerContext ()

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::AuthContext >	auth_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...

void	AsyncNotifyWhenDone (void *tag)
	Async only. More...

grpc_call *	c_call ()
	Should be used for framework-level extensions only. More...

Friends
class	::grpc::testing::InteropServerContextInspector

class	::grpc::testing::ServerContextTestSpouse

class	::grpc::ServerInterface

class	::grpc_impl::Server

template<class W , class R >
class	::grpc_impl::ServerAsyncReader

template<class W >
class	::grpc_impl::ServerAsyncWriter

template<class W >
class	::grpc_impl::ServerAsyncResponseWriter

template<class W , class R >
class	::grpc_impl::ServerAsyncReaderWriter

template<class R >
class	::grpc_impl::ServerReader

template<class W >
class	::grpc_impl::ServerWriter

template<class W , class R >
class	::grpc_impl::internal::ServerReaderWriterBody

template<class ServiceType , class RequestType , class ResponseType >
class	::grpc::internal::RpcMethodHandler

template<class ServiceType , class RequestType , class ResponseType >
class	::grpc::internal::ClientStreamingHandler

template<class ServiceType , class RequestType , class ResponseType >
class	::grpc::internal::ServerStreamingHandler

template<class Streamer , bool WriteNeeded>
class	::grpc::internal::TemplatedBidiStreamingHandler

template<class RequestType , class ResponseType >
class	::grpc_impl::internal::CallbackUnaryHandler

template<class RequestType , class ResponseType >
class	::grpc_impl::internal::CallbackClientStreamingHandler

template<class RequestType , class ResponseType >
class	::grpc_impl::internal::CallbackServerStreamingHandler

template<class RequestType , class ResponseType >
class	::grpc_impl::internal::CallbackBidiHandler

template<::grpc::StatusCode code>
class	::grpc::internal::ErrorMethodHandler

class	::grpc_impl::ClientContext

class	::grpc::GenericServerContext

Detailed Description

A ServerContext allows the person implementing a service handler to:

Add custom initial and trailing metadata key-value pairs that will propagated to the client side.
Control call settings such as compression and authentication.
Access metadata coming from the client.
Get performance metrics (ie, census).

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 ( )

◆ ~ServerContext()

grpc_impl::ServerContext::~ServerContext ( )

Member Function Documentation

◆ AddInitialMetadata()

void grpc_impl::ServerContext::AddInitialMetadata	(	const grpc::string &	key,
		const grpc::string &	value
	)

Add the (key, value) pair to the initial metadata associated with a server call.

These are made available at the client side by the grpc::ClientContext::GetServerInitialMetadata() method.

Warning: This method should only be called before sending initial metadata to the client (which can happen explicitly, or implicitly when sending a a response message or status to the client).

Parameters

key	The metadata key. If value is binary data, it must end in "-bin".
value	The metadata value. If its value is binary, the key name must end in "-bin".

Metadata must conform to the following format: Custom-Metadata -> Binary-Header / ASCII-Header Binary-Header -> {Header-Name "-bin" } {binary value} ASCII-Header -> Header-Name ASCII-Value Header-Name -> 1*( x30-39 / x61-7A / "_" / "-" / ".") ; 0-9 a-z _ - . ASCII-Value -> 1*( x20-x7E ) ; space and printable ASCII

◆ AddTrailingMetadata()

void grpc_impl::ServerContext::AddTrailingMetadata	(	const grpc::string &	key,
		const grpc::string &	value
	)

Add the (key, value) pair to the initial metadata associated with a server call.

These are made available at the client side by the grpc::ClientContext::GetServerTrailingMetadata() method.

Warning: This method should only be called before sending trailing metadata to the client (which happens when the call is finished and a status is sent to the client).

Parameters

key	The metadata key. If value is binary data, it must end in "-bin".
value	The metadata value. If its value is binary, the key name must end in "-bin".

Metadata must conform to the following format: Custom-Metadata -> Binary-Header / ASCII-Header Binary-Header -> {Header-Name "-bin" } {binary value} ASCII-Header -> Header-Name ASCII-Value Header-Name -> 1*( x30-39 / x61-7A / "_" / "-" / ".") ; 0-9 a-z _ - . ASCII-Value -> 1*( x20-x7E ) ; space and printable ASCII

◆ AsyncNotifyWhenDone()

void grpc_impl::ServerContext::AsyncNotifyWhenDone ( void * tag )

inline

Async only.

Has to be called before the rpc starts. Returns the tag in completion queue when the rpc finishes. IsCancelled() can then be called to check whether the rpc was cancelled. TODO(vjpai): Fix this so that the tag is returned even if the call never starts (https://github.com/grpc/grpc/issues/10136).

◆ auth_context()

std::shared_ptr<const ::grpc::AuthContext> grpc_impl::ServerContext::auth_context ( ) const

inline

Return the authentication context for this server call.

See also: grpc::AuthContext.

◆ c_call()

grpc_call* grpc_impl::ServerContext::c_call ( )

inline

Should be used for framework-level extensions only.

Applications never need to call this method.

◆ census_context()

const struct census_context* grpc_impl::ServerContext::census_context ( ) const

Get the census context associated with this server call.

◆ client_metadata()

const std::multimap<grpc::string_ref, grpc::string_ref>& grpc_impl::ServerContext::client_metadata ( ) const

inline

Return a collection of initial metadata key-value pairs sent from the client.

Note that keys may happen more than once (ie, a std::multimap is returned).

It is safe to use this method after initial metadata has been received, Calls always begin with the client sending initial metadata, so this is safe to access as soon as the call has begun on the server side.

Returns: A multimap of initial metadata key-value pairs from the server.

◆ compression_algorithm()

grpc_compression_algorithm grpc_impl::ServerContext::compression_algorithm ( ) const

inline

Return the compression algorithm the server call will request be used.

Note that the gRPC runtime may decide to ignore this request, for example, due to resource constraints, or if the server is aware the client doesn't support the requested algorithm.

◆ compression_level()

grpc_compression_level grpc_impl::ServerContext::compression_level ( ) const

inline

Return the compression algorithm to be used by the server call.

◆ compression_level_set()

bool grpc_impl::ServerContext::compression_level_set ( ) const

inline

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.

◆ deadline()

std::chrono::system_clock::time_point grpc_impl::ServerContext::deadline ( ) const

inline

Return the deadline for the server call.

◆ IsCancelled()

bool grpc_impl::ServerContext::IsCancelled ( ) const

IsCancelled is always safe to call when using sync or callback API.

When using async API, it is only safe to call IsCancelled after the AsyncNotifyWhenDone tag has been delivered.

◆ peer()

grpc::string grpc_impl::ServerContext::peer ( ) const

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.

◆ raw_deadline()

gpr_timespec grpc_impl::ServerContext::raw_deadline ( ) const

inline

Return a gpr_timespec representation of the server call's deadline.

◆ set_compression_algorithm()

void grpc_impl::ServerContext::set_compression_algorithm ( grpc_compression_algorithm algorithm )

Set algorithm to be the compression algorithm used for the server call.

Parameters

algorithm The compression algorithm used for the server call.

◆ set_compression_level()

void grpc_impl::ServerContext::set_compression_level ( grpc_compression_level level )

inline

Set level to be the compression level used for the server call.

Parameters

level The compression level used for the server call.

◆ SetLoadReportingCosts()

void grpc_impl::ServerContext::SetLoadReportingCosts ( const std::vector< grpc::string > & cost_data )

Set the serialized load reporting costs in cost_data for the call.

◆ TryCancel()

void grpc_impl::ServerContext::TryCancel ( ) const

Cancel the Call from the server.

This is a best-effort API and depending on when it is called, the RPC may still appear successful to the client. For example, if TryCancel() is called on a separate thread, it might race with the server handler which might return success to the client before TryCancel() was even started by the thread.

It is the caller's responsibility to prevent such races and ensure that if TryCancel() is called, the serverhandler must return Status::CANCELLED. The only exception is that if the serverhandler is already returning an error status code, it is ok to not return Status::CANCELLED even if TryCancel() was called.

Note that TryCancel() does not change any of the tags that are pending on the completion queue. All pending tags will still be delivered (though their ok result may reflect the effect of cancellation).