Namespaces
	aio

	binder

	gevent

	session_cache

Classes
class	AltsContext

struct	AltsCredentialsOptions
	Options used to build AltsCredentials. More...

struct	AltsServerCredentialsOptions
	Options to create ServerCredentials with ALTS. More...

class	AuthorizationPolicyProviderInterface

class	CallMetricRecorder

class	CertificateProviderInterface

class	CertificateVerifier

class	ChannelOptions

class	ClientInterceptorFactoryInterface

class	ClientRpcInfo

class	DelegatingChannel

class	ExperimentalApiWarning

class	ExternalCertificateVerifier

class	ExternalConnectionAcceptor

class	FileWatcherAuthorizationPolicyProvider

class	FileWatcherCertificateProvider

class	HostNameCertificateVerifier

struct	IdentityKeyCertPair

class	Interceptor

class	InterceptorBatchMethods

class	NoOpCertificateVerifier

class	OrcaServerInterceptor

class	OrcaServerInterceptorFactory

class	OrcaService

class	ServerInterceptorFactoryInterface

class	ServerRpcInfo

class	StaticDataAuthorizationPolicyProvider

class	StaticDataCertificateProvider

struct	StsCredentialsOptions

class	TlsChannelCredentialsOptions

class	TlsCredentialsOptions

class	TlsCustomVerificationCheckRequest

class	TlsServerCredentialsOptions

class	UsageError

Typedefs
template<class Request , class Response >
using	ServerBidiReactor = ::grpc::ServerBidiReactor< Request, Response >

Enumerations
enum	InterceptionHookPoints { InterceptionHookPoints::PRE_SEND_INITIAL_METADATA, InterceptionHookPoints::PRE_SEND_MESSAGE, InterceptionHookPoints::POST_SEND_MESSAGE, InterceptionHookPoints::PRE_SEND_STATUS, InterceptionHookPoints::PRE_SEND_CLOSE, InterceptionHookPoints::PRE_RECV_INITIAL_METADATA, InterceptionHookPoints::PRE_RECV_MESSAGE, InterceptionHookPoints::PRE_RECV_STATUS, InterceptionHookPoints::POST_RECV_INITIAL_METADATA, InterceptionHookPoints::POST_RECV_MESSAGE, InterceptionHookPoints::POST_RECV_STATUS, InterceptionHookPoints::POST_RECV_CLOSE, InterceptionHookPoints::PRE_SEND_CANCEL, InterceptionHookPoints::NUM_INTERCEPTION_HOOKS }

Functions
def	_warn_experimental (api_name, stack_offset)

grpc::Status	AltsClientAuthzCheck (const std::shared_ptr< const AuthContext > &auth_context, const std::vector< std::string > &expected_service_accounts)

std::shared_ptr< ChannelCredentials >	AltsCredentials (const AltsCredentialsOptions &options)
	Builds ALTS Credentials given ALTS specific options. More...

std::shared_ptr< ServerCredentials >	AltsServerCredentials (const AltsServerCredentialsOptions &options)
	Builds ALTS ServerCredentials given ALTS specific options. More...

std::shared_ptr< grpc::ServerCredentials >	BinderServerCredentials (std::shared_ptr< grpc::experimental::binder::SecurityPolicy > security_policy)

void	ChannelResetConnectionBackoff (Channel *channel)

std::shared_ptr< Channel >	CreateCustomChannelWithInterceptors (const grpc::string &target, const std::shared_ptr< ChannelCredentials > &creds, const ChannelArguments &args, std::vector< std::unique_ptr< experimental::ClientInterceptorFactoryInterface >> interceptor_creators)

std::shared_ptr< grpc::Channel >	CreateCustomChannelWithInterceptors (const grpc::string &target, const std::shared_ptr< grpc::ChannelCredentials > &creds, const grpc::ChannelArguments &args, std::vector< std::unique_ptr< grpc::experimental::ClientInterceptorFactoryInterface >> interceptor_creators)

std::shared_ptr< grpc::Channel >	CreateCustomChannelWithInterceptors (const std::string &target, const std::shared_ptr< grpc::ChannelCredentials > &creds, const grpc::ChannelArguments &args, std::vector< std::unique_ptr< grpc::experimental::ClientInterceptorFactoryInterface >> interceptor_creators)

void	EnableCallMetricRecording (ServerBuilder *)

def	experimental_api (f)

std::unique_ptr< AltsContext >	GetAltsContextFromAuthContext (const std::shared_ptr< const AuthContext > &auth_context)

def	insecure_channel_credentials ()

std::shared_ptr< ChannelCredentials >	LocalCredentials (grpc_local_connect_type type)
	Builds Local Credentials. More...

std::shared_ptr< ServerCredentials >	LocalServerCredentials (grpc_local_connect_type type)

std::shared_ptr< CallCredentials >	MetadataCredentialsFromPlugin (std::unique_ptr< MetadataCredentialsPlugin > plugin, grpc_security_level min_security_level)

void	RegisterGlobalClientInterceptorFactory (ClientInterceptorFactoryInterface *factory)

std::shared_ptr< CallCredentials >	StsCredentials (const StsCredentialsOptions &options)

grpc_sts_credentials_options	StsCredentialsCppToCoreOptions (const StsCredentialsOptions &options)

grpc::Status	StsCredentialsOptionsFromEnv (StsCredentialsOptions *options)

grpc::Status	StsCredentialsOptionsFromJson (const std::string &json_string, StsCredentialsOptions *options)

void	TestOnlyResetGlobalClientInterceptorFactory ()

std::shared_ptr< ChannelCredentials >	TlsCredentials (const TlsChannelCredentialsOptions &options)
	Builds TLS Credentials given TLS options. More...

std::shared_ptr< ServerCredentials >	TlsServerCredentials (const experimental::TlsServerCredentialsOptions &options)
	Builds TLS ServerCredentials given TLS options. More...

std::string	ValidateServiceConfigJSON (const std::string &service_config_json)

def	wrap_server_method_handler (wrapper, handler)

std::shared_ptr< ChannelCredentials >	XdsCredentials (const std::shared_ptr< ChannelCredentials > &fallback_creds)

std::shared_ptr< ServerCredentials >	XdsServerCredentials (const std::shared_ptr< ServerCredentials > &fallback_credentials)

Variables
tuple	__all__

	_EXPERIMENTAL_APIS_USED = set()

	_insecure_channel_credentials

static internal::GrpcLibraryInitializer	g_gli_initializer

Detailed Description

ClientRpcInfo represents the state of a particular RPC as it appears to an interceptor. It is created and owned by the library and passed to the CreateClientInterceptor method of the application's ClientInterceptorFactoryInterface implementation

Typedef Documentation

◆ ServerBidiReactor

template<class Request , class Response >

using grpc::experimental::ServerBidiReactor = typedef ::grpc::ServerBidiReactor<Request, Response>

Definition at line 793 of file impl/codegen/server_callback.h.

Enumeration Type Documentation

◆ InterceptionHookPoints

enum grpc::experimental::InterceptionHookPoints

strong

An enumeration of different possible points at which the Intercept method of the Interceptor interface may be called. Any given call to Intercept will include one or more of these hook points, and each hook point makes certain types of information available to the interceptor. In these enumeration names, PRE_SEND means that an interception has taken place between the time the application provided a certain type of data (e.g., initial metadata, status) and the time that that data goes to the other side. POST_SEND means that the data has been committed for going to the other side (even if it has not yet been received at the other side). PRE_RECV means an interception between the time that a certain operation has been requested and it is available. POST_RECV means that a result is available but has not yet been passed back to the application. A batch of interception points will only contain either PRE or POST hooks but not both types. For example, a batch with PRE_SEND hook points will not contain POST_RECV or POST_SEND ops. Likewise, a batch with POST_* ops can not contain PRE_* ops.

Enumerator
PRE_SEND_INITIAL_METADATA	The first three in this list are for clients and servers.
PRE_SEND_MESSAGE
POST_SEND_MESSAGE
PRE_SEND_STATUS
PRE_SEND_CLOSE
PRE_RECV_INITIAL_METADATA	The following three are for hijacked clients only. A batch with PRE_RECV_* hook points will never contain hook points of other types.
PRE_RECV_MESSAGE
PRE_RECV_STATUS
POST_RECV_INITIAL_METADATA	The following two are for all clients and servers.
POST_RECV_MESSAGE
POST_RECV_STATUS
POST_RECV_CLOSE
PRE_SEND_CANCEL	This is a special hook point available to both clients and servers when TryCancel() is performed. No other hook points will be present along with this. It is illegal for an interceptor to block/delay this operation. ALL interceptors see this hook point irrespective of whether the RPC was hijacked or not.
NUM_INTERCEPTION_HOOKS

Definition at line 59 of file impl/codegen/interceptor.h.

Function Documentation

◆ _warn_experimental()

def grpc.experimental._warn_experimental	(	api_name,
		stack_offset
	)

private

Definition at line 63 of file src/python/grpcio/grpc/experimental/__init__.py.

◆ AltsClientAuthzCheck()

grpc::Status grpc::experimental::AltsClientAuthzCheck	(	const std::shared_ptr< const AuthContext > &	auth_context,
		const std::vector< std::string > &	expected_service_accounts
	)

Definition at line 69 of file alts_util.cc.

◆ AltsCredentials()

std::shared_ptr< ChannelCredentials > grpc::experimental::AltsCredentials ( const AltsCredentialsOptions & options )

Builds ALTS Credentials given ALTS specific options.

Definition at line 294 of file secure_credentials.cc.

◆ AltsServerCredentials()

std::shared_ptr< ServerCredentials > grpc::experimental::AltsServerCredentials ( const AltsServerCredentialsOptions & options )

Builds ALTS ServerCredentials given ALTS specific options.

Builds Local ServerCredentials.

Definition at line 136 of file secure_server_credentials.cc.

◆ BinderServerCredentials()

std::shared_ptr< ServerCredentials > grpc::experimental::BinderServerCredentials ( std::shared_ptr< grpc::experimental::binder::SecurityPolicy > security_policy )

EXPERIMENTAL Builds Binder ServerCredentials.

This should be used along with binder: URI scheme. The path in the URI can later be used to access the server's endpoint binder. Note that calling ServerBuilder::AddListeningPort() with Binder ServerCredentials in a non-supported environment will make the subsequent call to ServerBuilder::BuildAndStart() return a null pointer.

Definition at line 66 of file binder_server_credentials.cc.

◆ ChannelResetConnectionBackoff()

void grpc::experimental::ChannelResetConnectionBackoff ( Channel * channel )

Resets the channel's connection backoff. TODO(roth): Once we see whether this proves useful, either create a gRFC and change this to be a method of the Channel class, or remove it.

Definition at line 111 of file channel_cc.cc.

◆ CreateCustomChannelWithInterceptors() [1/3]

std::shared_ptr<Channel> grpc::experimental::CreateCustomChannelWithInterceptors	(	const grpc::string &	target,
		const std::shared_ptr< ChannelCredentials > &	creds,
		const ChannelArguments &	args,
		std::vector< std::unique_ptr< experimental::ClientInterceptorFactoryInterface >>	interceptor_creators
	)

Create a new custom Channel pointing to target with interceptors being invoked per call.

Warning: For advanced use and testing ONLY. Override default channel arguments only if necessary.

Parameters

target	The URI of the endpoint to connect to.
creds	Credentials to use for the created channel. If it does not hold an object or is invalid, a lame channel (one on which all operations fail) is returned.
args	Options for channel creation.

◆ CreateCustomChannelWithInterceptors() [2/3]

std::shared_ptr<grpc::Channel> grpc::experimental::CreateCustomChannelWithInterceptors	(	const grpc::string &	target,
		const std::shared_ptr< grpc::ChannelCredentials > &	creds,
		const grpc::ChannelArguments &	args,
		std::vector< std::unique_ptr< grpc::experimental::ClientInterceptorFactoryInterface >>	interceptor_creators
	)

◆ CreateCustomChannelWithInterceptors() [3/3]

std::shared_ptr<grpc::Channel> grpc::experimental::CreateCustomChannelWithInterceptors	(	const std::string &	target,
		const std::shared_ptr< grpc::ChannelCredentials > &	creds,
		const grpc::ChannelArguments &	args,
		std::vector< std::unique_ptr< grpc::experimental::ClientInterceptorFactoryInterface >>	interceptor_creators
	)

Create a new custom Channel pointing to target with interceptors being invoked per call.

Warning: For advanced use and testing ONLY. Override default channel arguments only if necessary.

Parameters

target	The URI of the endpoint to connect to.
creds	Credentials to use for the created channel. If it does not hold an object or is invalid, a lame channel (one on which all operations fail) is returned.
args	Options for channel creation.

Definition at line 72 of file create_channel.cc.

◆ EnableCallMetricRecording()

void grpc::experimental::EnableCallMetricRecording ( grpc::ServerBuilder * builder )

Definition at line 74 of file orca_interceptor.cc.

◆ experimental_api()

def grpc.experimental.experimental_api ( f )

Definition at line 72 of file src/python/grpcio/grpc/experimental/__init__.py.

◆ GetAltsContextFromAuthContext()

std::unique_ptr< AltsContext > grpc::experimental::GetAltsContextFromAuthContext ( const std::shared_ptr< const AuthContext > & auth_context )

Definition at line 42 of file alts_util.cc.

◆ insecure_channel_credentials()

def grpc.experimental.insecure_channel_credentials ( )

Creates a ChannelCredentials for use with an insecure channel.

THIS IS AN EXPERIMENTAL API.

Definition at line 51 of file src/python/grpcio/grpc/experimental/__init__.py.

◆ LocalCredentials()

std::shared_ptr< ChannelCredentials > grpc::experimental::LocalCredentials ( grpc_local_connect_type type )

Builds Local Credentials.

Definition at line 309 of file secure_credentials.cc.

◆ LocalServerCredentials()

std::shared_ptr< ServerCredentials > grpc::experimental::LocalServerCredentials ( grpc_local_connect_type type )

Definition at line 147 of file secure_server_credentials.cc.

◆ MetadataCredentialsFromPlugin()

std::shared_ptr< CallCredentials > grpc::experimental::MetadataCredentialsFromPlugin	(	std::unique_ptr< MetadataCredentialsPlugin >	plugin,
		grpc_security_level	min_security_level
	)

Definition at line 278 of file secure_credentials.cc.

◆ RegisterGlobalClientInterceptorFactory()

void grpc::experimental::RegisterGlobalClientInterceptorFactory ( ClientInterceptorFactoryInterface * factory )

Definition at line 30 of file client_interceptor.cc.

◆ StsCredentials()

std::shared_ptr< CallCredentials > grpc::experimental::StsCredentials ( const StsCredentialsOptions & options )

Definition at line 272 of file secure_credentials.cc.

◆ StsCredentialsCppToCoreOptions()

grpc_sts_credentials_options grpc::experimental::StsCredentialsCppToCoreOptions ( const StsCredentialsOptions & options )

Definition at line 255 of file secure_credentials.cc.

◆ StsCredentialsOptionsFromEnv()

grpc::Status grpc::experimental::StsCredentialsOptionsFromEnv ( StsCredentialsOptions * options )

Creates STS credentials options from the $STS_CREDENTIALS environment variable. This environment variable points to the path of a JSON file comforming to the schema described above.

Definition at line 219 of file secure_credentials.cc.

◆ StsCredentialsOptionsFromJson()

grpc::Status grpc::experimental::StsCredentialsOptionsFromJson	(	const std::string &	json_string,
		StsCredentialsOptions *	options
	)

Definition at line 162 of file secure_credentials.cc.

◆ TestOnlyResetGlobalClientInterceptorFactory()

void grpc::experimental::TestOnlyResetGlobalClientInterceptorFactory ( )

Definition at line 41 of file client_interceptor.cc.

◆ TlsCredentials()

std::shared_ptr< ChannelCredentials > grpc::experimental::TlsCredentials ( const TlsChannelCredentialsOptions & options )

Builds TLS Credentials given TLS options.

Definition at line 316 of file secure_credentials.cc.

◆ TlsServerCredentials()

std::shared_ptr< ServerCredentials > grpc::experimental::TlsServerCredentials ( const experimental::TlsServerCredentialsOptions & options )

Builds TLS ServerCredentials given TLS options.

Definition at line 153 of file secure_server_credentials.cc.

◆ ValidateServiceConfigJSON()

std::string grpc::experimental::ValidateServiceConfigJSON ( const std::string & service_config_json )

Validates service_config_json. If valid, returns an empty string. Otherwise, returns the validation error. TODO(yashykt): Promote it to out of experimental once it is proved useful and gRFC is accepted.

Definition at line 30 of file validate_service_config.cc.

◆ wrap_server_method_handler()

def grpc.experimental.wrap_server_method_handler	(	wrapper,
		handler
	)

Wraps the server method handler function.

The server implementation requires all server handlers being wrapped as
RpcMethodHandler objects. This helper function ease the pain of writing
server handler wrappers.

Args:
    wrapper: A wrapper function that takes in a method handler behavior
      (the actual function) and returns a wrapped function.
    handler: A RpcMethodHandler object to be wrapped.

Returns:
    A newly created RpcMethodHandler.

Definition at line 82 of file src/python/grpcio/grpc/experimental/__init__.py.

◆ XdsCredentials()

std::shared_ptr<ChannelCredentials> grpc::experimental::XdsCredentials ( const std::shared_ptr< ChannelCredentials > & fallback_creds )

Definition at line 48 of file cpp/client/xds_credentials.cc.

◆ XdsServerCredentials()

std::shared_ptr<ServerCredentials> grpc::experimental::XdsServerCredentials ( const std::shared_ptr< ServerCredentials > & fallback_credentials )

Definition at line 48 of file xds_server_credentials.cc.

Variable Documentation

◆ all

tuple grpc.experimental.__all__

private

Initial value:

 =  (
     'ChannelOptions',
     'ExperimentalApiWarning',
     'UsageError',
     'insecure_channel_credentials',
     'wrap_server_method_handler',
 )

Definition at line 115 of file src/python/grpcio/grpc/experimental/__init__.py.

◆ _EXPERIMENTAL_APIS_USED

grpc.experimental._EXPERIMENTAL_APIS_USED = set()

private

Definition at line 27 of file src/python/grpcio/grpc/experimental/__init__.py.

◆ _insecure_channel_credentials

grpc.experimental._insecure_channel_credentials

private

Initial value:

1 = grpc.ChannelCredentials(

2 _cygrpc.channel_credentials_insecure())

Definition at line 47 of file src/python/grpcio/grpc/experimental/__init__.py.

◆ g_gli_initializer

internal::GrpcLibraryInitializer grpc::experimental::g_gli_initializer

static

Definition at line 40 of file tls_certificate_verifier.cc.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

◆ ServerBidiReactor

Enumeration Type Documentation

◆ InterceptionHookPoints

Function Documentation

◆ _warn_experimental()

◆ AltsClientAuthzCheck()

◆ AltsCredentials()

◆ AltsServerCredentials()

◆ BinderServerCredentials()

◆ ChannelResetConnectionBackoff()

◆ CreateCustomChannelWithInterceptors() [1/3]

◆ CreateCustomChannelWithInterceptors() [2/3]

◆ CreateCustomChannelWithInterceptors() [3/3]

◆ EnableCallMetricRecording()

◆ experimental_api()

◆ GetAltsContextFromAuthContext()

◆ insecure_channel_credentials()

◆ LocalCredentials()

◆ LocalServerCredentials()

◆ MetadataCredentialsFromPlugin()

◆ RegisterGlobalClientInterceptorFactory()

◆ StsCredentials()

◆ StsCredentialsCppToCoreOptions()

◆ StsCredentialsOptionsFromEnv()

◆ StsCredentialsOptionsFromJson()

◆ TestOnlyResetGlobalClientInterceptorFactory()

◆ TlsCredentials()

◆ TlsServerCredentials()

◆ ValidateServiceConfigJSON()

◆ wrap_server_method_handler()

◆ XdsCredentials()

◆ XdsServerCredentials()

Variable Documentation

◆ __all__

◆ _EXPERIMENTAL_APIS_USED

◆ _insecure_channel_credentials

◆ g_gli_initializer

◆ all