package internal

import "google.golang.org/grpc/internal"

Package internal contains gRPC-internal code, to avoid polluting the godoc of the top-level grpc package. It must not import any grpc symbols to avoid circular dependencies.

Index

Constants

const (
	// CredsBundleModeFallback switches GoogleDefaultCreds to fallback mode.
	CredsBundleModeFallback = "fallback"
	// CredsBundleModeBalancer switches GoogleDefaultCreds to grpclb balancer
	// mode.
	CredsBundleModeBalancer = "balancer"
	// CredsBundleModeBackendFromBalancer switches GoogleDefaultCreds to mode
	// that supports backend returned by grpclb balancer.
	CredsBundleModeBackendFromBalancer = "backend-from-balancer"
)

Variables

var (
	// WithHealthCheckFunc is set by dialoptions.go
	WithHealthCheckFunc interface{} // func (HealthChecker) DialOption
	// HealthCheckFunc is used to provide client-side LB channel health checking
	HealthCheckFunc HealthChecker
	// BalancerUnregister is exported by package balancer to unregister a balancer.
	BalancerUnregister func(name string)
	// KeepaliveMinPingTime is the minimum ping interval.  This must be 10s by
	// default, but tests may wish to set it lower for convenience.
	KeepaliveMinPingTime = 10 * time.Second
	// ParseServiceConfigForTesting is for creating a fake
	// ClientConn for resolver testing only
	ParseServiceConfigForTesting interface{} // func(string) *serviceconfig.ParseResult
	// EqualServiceConfigForTesting is for testing service config generation and
	// parsing. Both a and b should be returned by ParseServiceConfigForTesting.
	// This function compares the config without rawJSON stripped, in case the
	// there's difference in white space.
	EqualServiceConfigForTesting func(a, b serviceconfig.Config) bool
	// GetCertificateProviderBuilder returns the registered builder for the
	// given name. This is set by package certprovider for use from xDS
	// bootstrap code while parsing certificate provider configs in the
	// bootstrap file.
	GetCertificateProviderBuilder interface{} // func(string) certprovider.Builder
	// GetXDSHandshakeInfoForTesting returns a pointer to the xds.HandshakeInfo
	// stored in the passed in attributes. This is set by
	// credentials/xds/xds.go.
	GetXDSHandshakeInfoForTesting interface{} // func (*attributes.Attributes) *xds.HandshakeInfo
	// GetServerCredentials returns the transport credentials configured on a
	// gRPC server. An xDS-enabled server needs to know what type of credentials
	// is configured on the underlying gRPC server. This is set by server.go.
	GetServerCredentials interface{} // func (*grpc.Server) credentials.TransportCredentials
	// DrainServerTransports initiates a graceful close of existing connections
	// on a gRPC server accepted on the provided listener address. An
	// xDS-enabled server invokes this method on a grpc.Server when a particular
	// listener moves to "not-serving" mode.
	DrainServerTransports interface{} // func(*grpc.Server, string)
)

Functions

func GetXDSHandshakeClusterName

func GetXDSHandshakeClusterName(attr *attributes.Attributes) (string, bool)

GetXDSHandshakeClusterName returns cluster name stored in attr.

func SetXDSHandshakeClusterName

func SetXDSHandshakeClusterName(addr resolver.Address, clusterName string) resolver.Address

SetXDSHandshakeClusterName returns a copy of addr in which the Attributes field is updated with the cluster name.

Types

type HealthChecker

type HealthChecker func(ctx context.Context, newStream func(string) (interface{}, error), setConnectivityState func(connectivity.State, error), serviceName string) error

HealthChecker defines the signature of the client-side LB channel health checking function.

The implementation is expected to create a health checking RPC stream by calling newStream(), watch for the health status of serviceName, and report it's health back by calling setConnectivityState().

The health checking protocol is defined at: https://github.com/grpc/grpc/blob/master/doc/health-checking.md

Source Files

internal.go xds_handshake_cluster.go

Directories

PathSynopsis
internal/adminPackage admin contains internal implementation for admin service.
internal/backoffPackage backoff implement the backoff strategy for gRPC.
internal/balancer
internal/balancerloadPackage balancerload defines APIs to parse server loads in trailers.
internal/balancer/stubPackage stub implements a balancer for testing purposes.
internal/binarylogPackage binarylog implementation binary logging as defined in https://github.com/grpc/proposal/blob/master/A16-binary-logging.md.
internal/bufferPackage buffer provides an implementation of an unbounded buffer.
internal/cachePackage cache implements caches to be used in gRPC.
internal/channelzPackage channelz defines APIs for enabling channelz service, entry registration/deletion, and accessing channelz data.
internal/credentialsPackage credentials defines APIs for parsing SPIFFE ID.
internal/credentials/xdsPackage xds contains non-user facing functionality of the xds credentials.
internal/envconfigPackage envconfig contains grpc settings configured by environment variables.
internal/googlecloudPackage googlecloud contains internal helpful functions for google cloud.
internal/grpclogPackage grpclog (internal) defines depth logging for grpc.
internal/grpcrandPackage grpcrand implements math/rand functions in a concurrent-safe way with a global random source, independent of math/rand's global source.
internal/grpcsyncPackage grpcsync implements additional synchronization primitives built upon the sync package.
internal/grpctestPackage grpctest implements testing helpers.
internal/grpcutilPackage grpcutil provides a bunch of utility functions to be used across the gRPC codebase.
internal/hierarchyPackage hierarchy contains functions to set and get hierarchy string from addresses.
internal/leakcheckPackage leakcheck contains functions to check leaked goroutines.
internal/metadataPackage metadata contains functions to set and get metadata from addresses.
internal/prettyPackage pretty defines helper functions to pretty-print structs for logging.
internal/profilingPackage profiling contains two logical components: buffer.go and profiling.go.
internal/profiling/bufferPackage buffer provides a high-performant lock free implementation of a circular buffer used by the profiling code.
internal/proto
internal/proto/grpc_service_config
internal/resolverPackage resolver provides internal resolver-related functionality.
internal/resolver/dnsPackage dns implements a dns resolver to be installed as the default resolver in grpc.
internal/resolver/passthroughPackage passthrough implements a pass-through resolver.
internal/resolver/unixPackage unix implements a resolver for unix targets.
internal/serviceconfigPackage serviceconfig contains utility functions to parse service config.
internal/statusPackage status implements errors returned by gRPC.
internal/stubserverPackage stubserver is a stubbable implementation of google.golang.org/grpc/test/grpc_testing for testing purposes.
internal/syscallPackage syscall provides functionalities that grpc uses to get low-level operating system stats/info.
internal/testutilsPackage testutils contains testing helpers.
internal/transportPackage transport defines and implements message oriented communication channel to complete various transactions (e.g., an RPC).
internal/transport/networktypePackage networktype declares the network type to be used in the default dialer.
internal/wrrPackage wrr contains the interface and common implementations of wrr algorithms.
internal/xdsPackage xds contains types that need to be shared between code under google.golang.org/grpc/xds/...
internal/xds/envPackage env acts a single source of definition for all environment variables related to the xDS implementation in gRPC.
internal/xds/matcherPackage matcher contains types that need to be shared between code under google.golang.org/grpc/xds/...
internal/xds/rbacPackage rbac provides service-level and method-level access control for a service.
Version
v1.41.1
Published
Dec 1, 2021
Platform
darwin/amd64
Imports
6 packages
Last checked
1 hour ago

Tools for package owners.