grpc::AuthMetadataProcessor Class Reference

Interface allowing custom server-side authorization based on credentials encoded in metadata. More...

#include <auth_metadata_processor.h>

Public Types
typedef std::multimap < grpc::string_ref, grpc::string_ref >	InputMetadata
typedef std::multimap < grpc::string, grpc::string >	OutputMetadata

Public Member Functions
virtual	~AuthMetadataProcessor ()
virtual bool	IsBlocking () const
	If this method returns true, the Process function will be scheduled in a different thread from the one processing the call. More...
virtual Status	Process (const InputMetadata &auth_metadata, AuthContext *context, OutputMetadata *consumed_auth_metadata, OutputMetadata *response_metadata)=0
	context is read/write: it contains the properties of the channel peer and it is the job of the Process method to augment it with properties derived from the passed-in auth_metadata. More...

Detailed Description

Interface allowing custom server-side authorization based on credentials encoded in metadata.

Objects of this type can be passed to ServerCredentials::SetAuthMetadataProcessor().

Member Typedef Documentation

typedef std::multimap<grpc::string_ref, grpc::string_ref> grpc::AuthMetadataProcessor::InputMetadata

typedef std::multimap<grpc::string, grpc::string> grpc::AuthMetadataProcessor::OutputMetadata

Constructor & Destructor Documentation

virtual grpc::AuthMetadataProcessor::~AuthMetadataProcessor ( )

inlinevirtual

Member Function Documentation

virtual bool grpc::AuthMetadataProcessor::IsBlocking ( ) const

inlinevirtual

If this method returns true, the Process function will be scheduled in a different thread from the one processing the call.

virtual Status grpc::AuthMetadataProcessor::Process ( const InputMetadata &  auth_metadata, AuthContext *  context, OutputMetadata *  consumed_auth_metadata, OutputMetadata *  response_metadata  )

pure virtual

context is read/write: it contains the properties of the channel peer and it is the job of the Process method to augment it with properties derived from the passed-in auth_metadata.

consumed_auth_metadata needs to be filled with metadata that has been consumed by the processor and will be removed from the call. response_metadata is the metadata that will be sent as part of the response. If the return value is not Status::OK, the rpc call will be aborted with the error code and error message sent back to the client.

---

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

• include/grpc++/security/auth_metadata_processor.h