grpc_impl::experimental::TlsServerAuthorizationCheckArg Class Reference

TLS server authorization check arguments, wraps grpc_tls_server_authorization_check_arg. More...

#include <tls_credentials_options.h>

Public Member Functions
	TlsServerAuthorizationCheckArg (grpc_tls_server_authorization_check_arg *arg)
	TlsServerAuthorizationCheckArg does not take ownership of the C arg passed to the constructor. More...
	~TlsServerAuthorizationCheckArg ()
void *	cb_user_data () const
	Getters for member fields. More...
int	success () const
grpc::string	target_name () const
grpc::string	peer_cert () const
grpc_status_code	status () const
grpc::string	error_details () const
void	set_cb_user_data (void *cb_user_data)
	Setters for member fields. More...
void	set_success (int success)
void	set_target_name (const grpc::string &target_name)
void	set_peer_cert (const grpc::string &peer_cert)
void	set_status (grpc_status_code status)
void	set_error_details (const grpc::string &error_details)
void	OnServerAuthorizationCheckDoneCallback ()
	Calls the C arg's callback function. More...

Detailed Description

TLS server authorization check arguments, wraps grpc_tls_server_authorization_check_arg.

It is used for experimental purposes for now and it is subject to change.

The server authorization check arg contains all the info necessary to schedule/cancel a server authorization check request. The callback function must be called after finishing the schedule operation. See the description of the grpc_tls_server_authorization_check_arg struct in grpc_security.h for more details.

Constructor & Destructor Documentation

TlsServerAuthorizationCheckArg()

grpc_impl::experimental::TlsServerAuthorizationCheckArg::TlsServerAuthorizationCheckArg

(

grpc_tls_server_authorization_check_arg *

arg

)

TlsServerAuthorizationCheckArg does not take ownership of the C arg passed to the constructor.

gRPC TLS server authorization check arg API implementation

One must remember to free any memory allocated to the C arg after using the setter functions below.

~TlsServerAuthorizationCheckArg()

grpc_impl::experimental::TlsServerAuthorizationCheckArg::~TlsServerAuthorizationCheckArg

(

)

Member Function Documentation

cb_user_data()

void * grpc_impl::experimental::TlsServerAuthorizationCheckArg::cb_user_data

(

)

const

Getters for member fields.

They return the corresponding fields of the underlying C arg.

error_details()

grpc::string grpc_impl::experimental::TlsServerAuthorizationCheckArg::error_details

(

)

const

OnServerAuthorizationCheckDoneCallback()

void grpc_impl::experimental::TlsServerAuthorizationCheckArg::OnServerAuthorizationCheckDoneCallback

(

)

Calls the C arg's callback function.

peer_cert()

grpc::string grpc_impl::experimental::TlsServerAuthorizationCheckArg::peer_cert

(

)

const

set_cb_user_data()

void grpc_impl::experimental::TlsServerAuthorizationCheckArg::set_cb_user_data

(

void *

cb_user_data

)

Setters for member fields.

They modify the fields of the underlying C arg. The setters for target_name, peer_cert, and error_details allocate memory when modifying c_arg_, so one must remember to free c_arg_'s original target_name, peer_cert, or error_details after using the appropriate setter function.

set_error_details()

void grpc_impl::experimental::TlsServerAuthorizationCheckArg::set_error_details

(

const grpc::string &

error_details

)

set_peer_cert()

void grpc_impl::experimental::TlsServerAuthorizationCheckArg::set_peer_cert

(

const grpc::string &

peer_cert

)

set_status()

void grpc_impl::experimental::TlsServerAuthorizationCheckArg::set_status

(

grpc_status_code

status

)

set_success()

void grpc_impl::experimental::TlsServerAuthorizationCheckArg::set_success

(

int

success

)

set_target_name()

void grpc_impl::experimental::TlsServerAuthorizationCheckArg::set_target_name

(

const grpc::string &

target_name

)

status()

grpc_status_code grpc_impl::experimental::TlsServerAuthorizationCheckArg::status

(

)

const

success()

int grpc_impl::experimental::TlsServerAuthorizationCheckArg::success

(

)

const

target_name()

grpc::string grpc_impl::experimental::TlsServerAuthorizationCheckArg::target_name

(

)

const

---

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

• include/grpcpp/security/tls_credentials_options.h
• src/cpp/common/tls_credentials_options.cc