TLS credential reload arguments, wraps grpc_tls_credential_reload_arg. More...

#include <tls_credentials_options.h>

Public Member Functions
	TlsCredentialReloadArg (grpc_tls_credential_reload_arg *arg)
	TlsCredentialReloadArg does not take ownership of the C arg that is passed to the constructor. More...

	~TlsCredentialReloadArg ()

void *	cb_user_data () const
	Getters for member fields. More...

bool	is_pem_key_cert_pair_list_empty () const

grpc_ssl_certificate_config_reload_status	status () const

std::string	error_details () const

void	set_cb_user_data (void *cb_user_data)
	Setters for member fields. More...

void	set_pem_root_certs (const std::string &pem_root_certs)

void	add_pem_key_cert_pair (const TlsKeyMaterialsConfig::PemKeyCertPair &pem_key_cert_pair)

void	set_key_materials (const std::string &pem_root_certs, std::vector< TlsKeyMaterialsConfig::PemKeyCertPair > pem_key_cert_pair_list)

void	set_key_materials_config (const std::shared_ptr< TlsKeyMaterialsConfig > &key_materials_config)

void	set_status (grpc_ssl_certificate_config_reload_status status)

void	set_error_details (const std::string &error_details)

void	OnCredentialReloadDoneCallback ()
	Calls the C arg's callback function. More...

Detailed Description

TLS credential reload arguments, wraps grpc_tls_credential_reload_arg.

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

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

Constructor & Destructor Documentation

◆ TlsCredentialReloadArg()

grpc::experimental::TlsCredentialReloadArg::TlsCredentialReloadArg ( grpc_tls_credential_reload_arg * arg )

TlsCredentialReloadArg does not take ownership of the C arg that is passed to the constructor.

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

◆ ~TlsCredentialReloadArg()

grpc::experimental::TlsCredentialReloadArg::~TlsCredentialReloadArg ( )

Member Function Documentation

◆ add_pem_key_cert_pair()

void grpc::experimental::TlsCredentialReloadArg::add_pem_key_cert_pair ( const TlsKeyMaterialsConfig::PemKeyCertPair & pem_key_cert_pair )

◆ cb_user_data()

void* grpc::experimental::TlsCredentialReloadArg::cb_user_data ( ) const

Getters for member fields.

◆ error_details()

std::string grpc::experimental::TlsCredentialReloadArg::error_details ( ) const

◆ is_pem_key_cert_pair_list_empty()

bool grpc::experimental::TlsCredentialReloadArg::is_pem_key_cert_pair_list_empty ( ) const

◆ OnCredentialReloadDoneCallback()

void grpc::experimental::TlsCredentialReloadArg::OnCredentialReloadDoneCallback ( )

Calls the C arg's callback function.

◆ set_cb_user_data()

void grpc::experimental::TlsCredentialReloadArg::set_cb_user_data ( void * cb_user_data )

Setters for member fields.

Ownership of the arguments will not be transferred.

◆ set_error_details()

void grpc::experimental::TlsCredentialReloadArg::set_error_details ( const std::string & error_details )

◆ set_key_materials()

void grpc::experimental::TlsCredentialReloadArg::set_key_materials	(	const std::string &	pem_root_certs,
		std::vector< TlsKeyMaterialsConfig::PemKeyCertPair >	pem_key_cert_pair_list
	)

◆ set_key_materials_config()

void grpc::experimental::TlsCredentialReloadArg::set_key_materials_config ( const std::shared_ptr< TlsKeyMaterialsConfig > & key_materials_config )

◆ set_pem_root_certs()

void grpc::experimental::TlsCredentialReloadArg::set_pem_root_certs ( const std::string & pem_root_certs )

◆ set_status()

void grpc::experimental::TlsCredentialReloadArg::set_status ( grpc_ssl_certificate_config_reload_status status )

◆ status()

grpc_ssl_certificate_config_reload_status grpc::experimental::TlsCredentialReloadArg::status ( ) const

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

include/grpcpp/security/tls_credentials_options.h

Public Member Functions