#include <server_context.h>

Inheritance diagram for grpc::ServerContextBase:

[legend]

Classes
struct	CallWrapper

class	CompletionOp

class	Reactor

class	TestServerCallbackUnary

Public Member Functions
void	AddInitialMetadata (const std::string &key, const std::string &value)

void	AddTrailingMetadata (const std::string &key, const std::string &value)

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

grpc_call *	c_call ()

const struct census_context *	census_context () const
	Get the census context associated with this server call. More...

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

grpc_compression_algorithm	compression_algorithm () const

grpc_compression_level	compression_level () const
	Return the compression algorithm to be used by the server call. More...

bool	compression_level_set () const

std::chrono::system_clock::time_point	deadline () const
	Return the deadline for the server call. More...

grpc::string_ref	ExperimentalGetAuthority () const

experimental::CallMetricRecorder *	ExperimentalGetCallMetricRecorder ()

bool	IsCancelled () const

std::string	peer () const

gpr_timespec	raw_deadline () const
	Return a gpr_timespec representation of the server call's deadline. More...

void	set_compression_algorithm (grpc_compression_algorithm algorithm)

void	set_compression_level (grpc_compression_level level)

void	SetLoadReportingCosts (const std::vector< std::string > &cost_data)
	Set the serialized load reporting costs in cost_data for the call. More...

void	TryCancel () const

virtual	~ServerContextBase ()

Protected Member Functions
void	AsyncNotifyWhenDone (void *tag)

ContextAllocator *	context_allocator () const

grpc::ServerUnaryReactor *	DefaultReactor ()

RpcAllocatorState *	GetRpcAllocatorState ()

	ServerContextBase ()
	Constructors for use by derived classes. More...

	ServerContextBase (gpr_timespec deadline, grpc_metadata_array *arr)

void	set_context_allocator (ContextAllocator *context_allocator)

Private Member Functions
void	BeginCompletionOp (grpc::internal::Call call, std::function< void(bool)> callback, grpc::internal::ServerCallbackCall callback_controller)

void	BindDeadlineAndMetadata (gpr_timespec deadline, grpc_metadata_array *arr)

void	CreateCallMetricRecorder ()

grpc::internal::CompletionQueueTag *	GetCompletionOpTag ()
	Return the tag queued by BeginCompletionOp() More...

uint32_t	initial_metadata_flags () const

void	MaybeMarkCancelledOnRead ()

ServerContextBase &	operator= (const ServerContextBase &)

	ServerContextBase (const ServerContextBase &)
	Prevent copying. More...

void	set_call (grpc_call *call)

void	set_message_allocator_state (RpcAllocatorState *allocator_state)

grpc::experimental::ServerRpcInfo *	set_server_rpc_info (const char *method, grpc::internal::RpcMethod::RpcType type, const std::vector< std::unique_ptr< grpc::experimental::ServerInterceptorFactoryInterface >> &creators)

void	SetupTestDefaultReactor (std::function< void(grpc::Status)> func)

grpc::Status	test_status () const

bool	test_status_set () const

Private Attributes
void *	async_notify_when_done_tag_ = nullptr

std::shared_ptr< const grpc::AuthContext >	auth_context_

CallWrapper	call_

experimental::CallMetricRecorder *	call_metric_recorder_ = nullptr

grpc::internal::MetadataMap	client_metadata_

CompletionOp *	completion_op_ = nullptr

grpc::internal::CallbackWithSuccessTag	completion_tag_

grpc_compression_algorithm	compression_algorithm_

grpc_compression_level	compression_level_

bool	compression_level_set_ = false

ContextAllocator *	context_allocator_ = nullptr

grpc::CompletionQueue *	cq_ = nullptr

gpr_timespec	deadline_

std::aligned_storage< sizeof(Reactor), alignof(Reactor)>::type	default_reactor_

std::atomic_bool	default_reactor_used_ {false}

bool	has_notify_when_done_tag_ = false

bool	has_pending_ops_ = false

std::multimap< std::string, std::string >	initial_metadata_

std::atomic_bool	marked_cancelled_ {false}

RpcAllocatorState *	message_allocator_state_ = nullptr

grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpSendMessage >	pending_ops_

grpc::experimental::ServerRpcInfo *	rpc_info_ = nullptr

bool	sent_initial_metadata_ = false

std::unique_ptr< TestServerCallbackUnary >	test_unary_

std::multimap< std::string, std::string >	trailing_metadata_

Friends
class	grpc::ClientContext

class	grpc::experimental::OrcaServerInterceptor

class	grpc::GenericCallbackServerContext

class	grpc::GenericServerContext

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

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

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

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

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

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

template<class Base >
class	grpc::internal::FinishOnlyReactor

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

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

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

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

template<class ResponseType >
void	grpc::internal::UnaryRunHandlerHelper (const internal::MethodHandler::HandlerParameter &param, ResponseType *rsp, Status &status)

class	grpc::Server

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

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

template<class W >
class	grpc::ServerAsyncResponseWriter

template<class W >
class	grpc::ServerAsyncWriter

class	grpc::ServerInterface

template<class R >
class	grpc::ServerReader

template<class W >
class	grpc::ServerWriter

class	grpc::testing::DefaultReactorTestPeer

class	grpc::testing::InteropServerContextInspector

class	grpc::testing::ServerContextTestSpouse

Detailed Description

Base class of ServerContext.

Definition at line 126 of file grpcpp/impl/codegen/server_context.h.

Constructor & Destructor Documentation

◆ ~ServerContextBase()

grpc::ServerContextBase::~ServerContextBase ( )

virtual

Definition at line 280 of file server_context.cc.

◆ ServerContextBase() [1/3]

grpc::ServerContextBase::ServerContextBase ( )

protected

Constructors for use by derived classes.

Definition at line 263 of file server_context.cc.

◆ ServerContextBase() [2/3]

grpc::ServerContextBase::ServerContextBase	(	gpr_timespec	deadline,
		grpc_metadata_array *	arr
	)

protected

Definition at line 268 of file server_context.cc.

◆ ServerContextBase() [3/3]

grpc::ServerContextBase::ServerContextBase ( const ServerContextBase & )

private

Prevent copying.

Member Function Documentation

◆ AddInitialMetadata()

void grpc::ServerContextBase::AddInitialMetadata	(	const std::string &	key,
		const std::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

Definition at line 330 of file server_context.cc.

◆ AddTrailingMetadata()

void grpc::ServerContextBase::AddTrailingMetadata	(	const std::string &	key,
		const std::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

Definition at line 335 of file server_context.cc.

◆ AsyncNotifyWhenDone()

void grpc::ServerContextBase::AsyncNotifyWhenDone ( void * tag )

inlineprotected

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

Definition at line 310 of file grpcpp/impl/codegen/server_context.h.

◆ auth_context()

std::shared_ptr<const grpc::AuthContext> grpc::ServerContextBase::auth_context ( ) const

inline

Return the authentication context for this server call.

See also: grpc::AuthContext.

Definition at line 271 of file grpcpp/impl/codegen/server_context.h.

◆ BeginCompletionOp()

void grpc::ServerContextBase::BeginCompletionOp	(	grpc::internal::Call *	call,
		std::function< void(bool)>	callback,
		grpc::internal::ServerCallbackCall *	callback_controller
	)

private

Definition at line 304 of file server_context.cc.

◆ BindDeadlineAndMetadata()

void grpc::ServerContextBase::BindDeadlineAndMetadata	(	gpr_timespec	deadline,
		grpc_metadata_array *	arr
	)

private

Definition at line 274 of file server_context.cc.

◆ c_call()

grpc_call* grpc::ServerContextBase::c_call ( )

inline

Should be used for framework-level extensions only. Applications never need to call this method.

Definition at line 289 of file grpcpp/impl/codegen/server_context.h.

◆ census_context()

const struct census_context * grpc::ServerContextBase::census_context ( ) const

Get the census context associated with this server call.

Definition at line 394 of file server_context.cc.

◆ client_metadata()

const std::multimap<grpc::string_ref, grpc::string_ref>& grpc::ServerContextBase::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.

Definition at line 230 of file grpcpp/impl/codegen/server_context.h.

◆ compression_algorithm()

grpc_compression_algorithm grpc::ServerContextBase::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.

Definition at line 257 of file grpcpp/impl/codegen/server_context.h.

◆ compression_level()

grpc_compression_level grpc::ServerContextBase::compression_level ( ) const

inline

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

Definition at line 236 of file grpcpp/impl/codegen/server_context.h.

◆ compression_level_set()

bool grpc::ServerContextBase::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.

Definition at line 251 of file grpcpp/impl/codegen/server_context.h.

◆ context_allocator()

ContextAllocator* grpc::ServerContextBase::context_allocator ( ) const

inlineprotected

Definition at line 359 of file grpcpp/impl/codegen/server_context.h.

◆ CreateCallMetricRecorder()

void grpc::ServerContextBase::CreateCallMetricRecorder ( )

private

Definition at line 407 of file server_context.cc.

◆ deadline()

std::chrono::system_clock::time_point grpc::ServerContextBase::deadline ( ) const

inline

Return the deadline for the server call.

Definition at line 131 of file grpcpp/impl/codegen/server_context.h.

◆ DefaultReactor()

grpc::ServerUnaryReactor* grpc::ServerContextBase::DefaultReactor ( )

inlineprotected

Get a library-owned default unary reactor for use in minimal reaction cases. This supports typical unary RPC usage of providing a response and status. It supports immediate Finish (finish from within the method handler) or delayed Finish (finish called after the method handler invocation). It does not support reacting to cancellation or completion, or early sending of initial metadata. Since this is a library-owned reactor, it should not be delete'd or freed in any way. This is more efficient than creating a user-owned reactor both because of avoiding an allocation and because its minimal reactions are optimized using a core surface flag that allows their reactions to run inline without any thread-hop.

This method should not be called more than once or called after return from the method handler.

Definition at line 334 of file grpcpp/impl/codegen/server_context.h.

◆ ExperimentalGetAuthority()

grpc::string_ref grpc::ServerContextBase::ExperimentalGetAuthority ( ) const

EXPERIMENTAL API Returns the call's authority.

Definition at line 413 of file server_context.cc.

◆ ExperimentalGetCallMetricRecorder()

experimental::CallMetricRecorder* grpc::ServerContextBase::ExperimentalGetCallMetricRecorder ( )

inline

Get the CallMetricRecorder object for the current RPC. Use it to record metrics during your RPC to send back to the client in order to make load balancing decisions. This will return nullptr if the feature hasn't been enabled using EnableCallMetricRecording.

Definition at line 296 of file grpcpp/impl/codegen/server_context.h.

◆ GetCompletionOpTag()

internal::CompletionQueueTag * grpc::ServerContextBase::GetCompletionOpTag ( )

private

Return the tag queued by BeginCompletionOp()

Definition at line 326 of file server_context.cc.

◆ GetRpcAllocatorState()

RpcAllocatorState* grpc::ServerContextBase::GetRpcAllocatorState ( )

inlineprotected

NOTE: This is an API for advanced users who need custom allocators. Get and maybe mutate the allocator state associated with the current RPC. Currently only applicable for callback unary RPC methods.

Definition at line 318 of file grpcpp/impl/codegen/server_context.h.

◆ initial_metadata_flags()

uint32_t grpc::ServerContextBase::initial_metadata_flags ( ) const

inlineprivate

Definition at line 427 of file grpcpp/impl/codegen/server_context.h.

◆ IsCancelled()

bool grpc::ServerContextBase::IsCancelled ( ) const

Return whether this RPC failed before the server could provide its status back to the client. This could be because of explicit API cancellation from the client-side or server-side, because of deadline exceeded, network connection reset, HTTP/2 parameter configuration (e.g., max message size, max connection age), etc. It does NOT include failure due to a non-OK status return from the server application's request handler, including Status::CANCELLED.

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. Thread-safe.

Definition at line 355 of file server_context.cc.

◆ MaybeMarkCancelledOnRead()

void grpc::ServerContextBase::MaybeMarkCancelledOnRead ( )

inlineprivate

Definition at line 444 of file grpcpp/impl/codegen/server_context.h.

◆ operator=()

ServerContextBase& grpc::ServerContextBase::operator= ( const ServerContextBase & )

private

◆ peer()

std::string grpc::ServerContextBase::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.

Definition at line 384 of file server_context.cc.

◆ raw_deadline()

gpr_timespec grpc::ServerContextBase::raw_deadline ( ) const

inline

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

Definition at line 136 of file grpcpp/impl/codegen/server_context.h.

◆ set_call()

void grpc::ServerContextBase::set_call ( grpc_call * call )

inlineprivate

Definition at line 423 of file grpcpp/impl/codegen/server_context.h.

◆ set_compression_algorithm()

void grpc::ServerContextBase::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.

Definition at line 371 of file server_context.cc.

◆ set_compression_level()

void grpc::ServerContextBase::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.

Definition at line 243 of file grpcpp/impl/codegen/server_context.h.

◆ set_context_allocator()

void grpc::ServerContextBase::set_context_allocator ( ContextAllocator * context_allocator )

inlineprotected

Definition at line 355 of file grpcpp/impl/codegen/server_context.h.

◆ set_message_allocator_state()

void grpc::ServerContextBase::set_message_allocator_state ( RpcAllocatorState * allocator_state )

inlineprivate

Definition at line 440 of file grpcpp/impl/codegen/server_context.h.

◆ set_server_rpc_info()

grpc::experimental::ServerRpcInfo* grpc::ServerContextBase::set_server_rpc_info	(	const char *	method,
		grpc::internal::RpcMethod::RpcType	type,
		const std::vector< std::unique_ptr< grpc::experimental::ServerInterceptorFactoryInterface >> &	creators
	)

inlineprivate

Definition at line 429 of file grpcpp/impl/codegen/server_context.h.

◆ SetLoadReportingCosts()

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

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

Definition at line 399 of file server_context.cc.

◆ SetupTestDefaultReactor()

void grpc::ServerContextBase::SetupTestDefaultReactor ( std::function< void(grpc::Status)> func )

inlineprivate

Definition at line 503 of file grpcpp/impl/codegen/server_context.h.

◆ test_status()

grpc::Status grpc::ServerContextBase::test_status ( ) const

inlineprivate

Definition at line 510 of file grpcpp/impl/codegen/server_context.h.

◆ test_status_set()

bool grpc::ServerContextBase::test_status_set ( ) const

inlineprivate

Definition at line 507 of file grpcpp/impl/codegen/server_context.h.

◆ TryCancel()

void grpc::ServerContextBase::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.

For reasons such as the above, it is generally preferred to explicitly finish an RPC by returning Status::CANCELLED rather than using TryCancel.

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

Definition at line 340 of file server_context.cc.