Documentation
¶
Overview ¶
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" )
const RLSLoadBalancingPolicyName = "rls_experimental"
RLSLoadBalancingPolicyName is the name of the RLS LB policy.
It currently has an experimental suffix which would be removed once end-to-end testing of the policy is completed.
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 // ParseServiceConfig parses a JSON representation of the service config. ParseServiceConfig interface{} // func(string) *serviceconfig.ParseResult // EqualServiceConfigForTesting is for testing service config generation and // parsing. Both a and b should be returned by ParseServiceConfig. // 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) // AddGlobalServerOptions adds an array of ServerOption that will be // effective globally for newly created servers. The priority will be: 1. // user-provided; 2. this method; 3. default values. AddGlobalServerOptions interface{} // func(opt ...ServerOption) // ClearGlobalServerOptions clears the array of extra ServerOption. This // method is useful in testing and benchmarking. ClearGlobalServerOptions func() // AddGlobalDialOptions adds an array of DialOption that will be effective // globally for newly created client channels. The priority will be: 1. // user-provided; 2. this method; 3. default values. AddGlobalDialOptions interface{} // func(opt ...DialOption) // ClearGlobalDialOptions clears the array of extra DialOption. This // method is useful in testing and benchmarking. ClearGlobalDialOptions func() // JoinServerOptions combines the server options passed as arguments into a // single server option. JoinServerOptions interface{} // func(...grpc.ServerOption) grpc.ServerOption // WithBinaryLogger returns a DialOption that specifies the binary logger // for a ClientConn. WithBinaryLogger interface{} // func(binarylog.Logger) grpc.DialOption // BinaryLogger returns a ServerOption that can set the binary logger for a // server. BinaryLogger interface{} // func(binarylog.Logger) grpc.ServerOption // NewXDSResolverWithConfigForTesting creates a new xds resolver builder using // the provided xds bootstrap config instead of the global configuration from // the supported environment variables. The resolver.Builder is meant to be // used in conjunction with the grpc.WithResolvers DialOption. // // Testing Only // // This function should ONLY be used for testing and may not work with some // other features, including the CSDS service. NewXDSResolverWithConfigForTesting interface{} // func([]byte) (resolver.Builder, error) // RegisterRLSClusterSpecifierPluginForTesting registers the RLS Cluster // Specifier Plugin for testing purposes, regardless of the XDSRLS environment // variable. // // TODO: Remove this function once the RLS env var is removed. RegisterRLSClusterSpecifierPluginForTesting func() // UnregisterRLSClusterSpecifierPluginForTesting unregisters the RLS Cluster // Specifier Plugin for testing purposes. This is needed because there is no way // to unregister the RLS Cluster Specifier Plugin after registering it solely // for testing purposes using RegisterRLSClusterSpecifierPluginForTesting(). // // TODO: Remove this function once the RLS env var is removed. UnregisterRLSClusterSpecifierPluginForTesting func() // RegisterRBACHTTPFilterForTesting registers the RBAC HTTP Filter for testing // purposes, regardless of the RBAC environment variable. // // TODO: Remove this function once the RBAC env var is removed. RegisterRBACHTTPFilterForTesting func() // UnregisterRBACHTTPFilterForTesting unregisters the RBAC HTTP Filter for // testing purposes. This is needed because there is no way to unregister the // HTTP Filter after registering it solely for testing purposes using // RegisterRBACHTTPFilterForTesting(). // // TODO: Remove this function once the RBAC env var is removed. UnregisterRBACHTTPFilterForTesting func() )
Functions ¶
func GetXDSHandshakeClusterName ¶ added in v1.38.0
func GetXDSHandshakeClusterName(attr *attributes.Attributes) (string, bool)
GetXDSHandshakeClusterName returns cluster name stored in attr.
Types ¶
type HealthChecker ¶ added in v1.18.0
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
Directories
¶
Path | Synopsis |
---|---|
Package admin contains internal implementation for admin service.
|
Package admin contains internal implementation for admin service. |
Package backoff implement the backoff strategy for gRPC.
|
Package backoff implement the backoff strategy for gRPC. |
balancer
|
|
gracefulswitch
Package gracefulswitch implements a graceful switch load balancer.
|
Package gracefulswitch implements a graceful switch load balancer. |
stub
Package stub implements a balancer for testing purposes.
|
Package stub implements a balancer for testing purposes. |
Package balancergroup implements a utility struct to bind multiple balancers into one balancer.
|
Package balancergroup implements a utility struct to bind multiple balancers into one balancer. |
Package balancerload defines APIs to parse server loads in trailers.
|
Package balancerload defines APIs to parse server loads in trailers. |
Package binarylog implementation binary logging as defined in https://github.com/grpc/proposal/blob/master/A16-binary-logging.md.
|
Package binarylog implementation binary logging as defined in https://github.com/grpc/proposal/blob/master/A16-binary-logging.md. |
Package buffer provides an implementation of an unbounded buffer.
|
Package buffer provides an implementation of an unbounded buffer. |
Package cache implements caches to be used in gRPC.
|
Package cache implements caches to be used in gRPC. |
Package channelz defines APIs for enabling channelz service, entry registration/deletion, and accessing channelz data.
|
Package channelz defines APIs for enabling channelz service, entry registration/deletion, and accessing channelz data. |
Package credentials defines APIs for parsing SPIFFE ID.
|
Package credentials defines APIs for parsing SPIFFE ID. |
xds
Package xds contains non-user facing functionality of the xds credentials.
|
Package xds contains non-user facing functionality of the xds credentials. |
Package envconfig contains grpc settings configured by environment variables.
|
Package envconfig contains grpc settings configured by environment variables. |
Package googlecloud contains internal helpful functions for google cloud.
|
Package googlecloud contains internal helpful functions for google cloud. |
Package grpclog (internal) defines depth logging for grpc.
|
Package grpclog (internal) defines depth logging for grpc. |
Package grpcrand implements math/rand functions in a concurrent-safe way with a global random source, independent of math/rand's global source.
|
Package grpcrand implements math/rand functions in a concurrent-safe way with a global random source, independent of math/rand's global source. |
Package grpcsync implements additional synchronization primitives built upon the sync package.
|
Package grpcsync implements additional synchronization primitives built upon the sync package. |
Package grpctest implements testing helpers.
|
Package grpctest implements testing helpers. |
Package grpcutil provides utility functions used across the gRPC codebase.
|
Package grpcutil provides utility functions used across the gRPC codebase. |
Package hierarchy contains functions to set and get hierarchy string from addresses.
|
Package hierarchy contains functions to set and get hierarchy string from addresses. |
Package leakcheck contains functions to check leaked goroutines.
|
Package leakcheck contains functions to check leaked goroutines. |
Package metadata contains functions to set and get metadata from addresses.
|
Package metadata contains functions to set and get metadata from addresses. |
Package pretty defines helper functions to pretty-print structs for logging.
|
Package pretty defines helper functions to pretty-print structs for logging. |
Package profiling contains two logical components: buffer.go and profiling.go.
|
Package profiling contains two logical components: buffer.go and profiling.go. |
buffer
Package buffer provides a high-performant lock free implementation of a circular buffer used by the profiling code.
|
Package buffer provides a high-performant lock free implementation of a circular buffer used by the profiling code. |
proto
|
|
Package resolver provides internal resolver-related functionality.
|
Package resolver provides internal resolver-related functionality. |
dns
Package dns implements a dns resolver to be installed as the default resolver in grpc.
|
Package dns implements a dns resolver to be installed as the default resolver in grpc. |
passthrough
Package passthrough implements a pass-through resolver.
|
Package passthrough implements a pass-through resolver. |
unix
Package unix implements a resolver for unix targets.
|
Package unix implements a resolver for unix targets. |
Package serviceconfig contains utility functions to parse service config.
|
Package serviceconfig contains utility functions to parse service config. |
Package status implements errors returned by gRPC.
|
Package status implements errors returned by gRPC. |
Package stubserver is a stubbable implementation of google.golang.org/grpc/test/grpc_testing for testing purposes.
|
Package stubserver is a stubbable implementation of google.golang.org/grpc/test/grpc_testing for testing purposes. |
Package syscall provides functionalities that grpc uses to get low-level operating system stats/info.
|
Package syscall provides functionalities that grpc uses to get low-level operating system stats/info. |
Package testutils contains testing helpers.
|
Package testutils contains testing helpers. |
fakegrpclb
Package fakegrpclb provides a fake implementation of the grpclb server.
|
Package fakegrpclb provides a fake implementation of the grpclb server. |
pickfirst
Package pickfirst contains helper functions to check for pickfirst load balancing of RPCs in tests.
|
Package pickfirst contains helper functions to check for pickfirst load balancing of RPCs in tests. |
rls
Package rls contains utilities for RouteLookupService e2e tests.
|
Package rls contains utilities for RouteLookupService e2e tests. |
roundrobin
Package roundrobin contains helper functions to check for roundrobin and weighted-roundrobin load balancing of RPCs in tests.
|
Package roundrobin contains helper functions to check for roundrobin and weighted-roundrobin load balancing of RPCs in tests. |
xds/bootstrap
Package bootstrap provides functionality to generate bootstrap configuration.
|
Package bootstrap provides functionality to generate bootstrap configuration. |
xds/e2e
Package e2e provides utilities for end2end testing of xDS functionality.
|
Package e2e provides utilities for end2end testing of xDS functionality. |
Package transport defines and implements message oriented communication channel to complete various transactions (e.g., an RPC).
|
Package transport defines and implements message oriented communication channel to complete various transactions (e.g., an RPC). |
networktype
Package networktype declares the network type to be used in the default dialer.
|
Package networktype declares the network type to be used in the default dialer. |
Package wrr contains the interface and common implementations of wrr algorithms.
|
Package wrr contains the interface and common implementations of wrr algorithms. |
xds
|
|
matcher
Package matcher contains types that need to be shared between code under google.golang.org/grpc/xds/...
|
Package matcher contains types that need to be shared between code under google.golang.org/grpc/xds/... |
rbac
Package rbac provides service-level and method-level access control for a service.
|
Package rbac provides service-level and method-level access control for a service. |