internal

package
v1.63.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 8, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

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

View Source 
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"
)
View Source 
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

View Source 
var (
	// WithRecvBufferPool is implemented by the grpc package and returns a dial
	// option to configure a shared buffer pool for a grpc.ClientConn.
	WithRecvBufferPool any // func (grpc.SharedBufferPool) grpc.DialOption

	// RecvBufferPool is implemented by the grpc package and returns a server
	// option to configure a shared buffer pool for a grpc.Server.
	RecvBufferPool any // func (grpc.SharedBufferPool) grpc.ServerOption
)
View Source 
var (
	// WithHealthCheckFunc is set by dialoptions.go
	WithHealthCheckFunc any // 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
	// KeepaliveMinServerPingTime is the minimum ping interval for servers.
	// This must be 1s by default, but tests may wish to set it lower for
	// convenience.
	KeepaliveMinServerPingTime = time.Second
	// ParseServiceConfig parses a JSON representation of the service config.
	ParseServiceConfig any // 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 any // 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 any // func (*attributes.Attributes) *unsafe.Pointer
	// 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 any // func (*grpc.Server) credentials.TransportCredentials
	// CanonicalString returns the canonical string of the code defined here:
	// https://github.com/grpc/grpc/blob/master/doc/statuscodes.md.
	//
	// This is used in the 1.0 release of gcp/observability, and thus must not be
	// deleted or changed.
	CanonicalString any // func (codes.Code) string
	// IsRegisteredMethod returns whether the passed in method is registered as
	// a method on the server.
	IsRegisteredMethod any // func(*grpc.Server, string) bool
	// ServerFromContext returns the server from the context.
	ServerFromContext any // func(context.Context) *grpc.Server
	// 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.
	//
	// This is used in the 1.0 release of gcp/observability, and thus must not be
	// deleted or changed.
	AddGlobalServerOptions any // func(opt ...ServerOption)
	// ClearGlobalServerOptions clears the array of extra ServerOption. This
	// method is useful in testing and benchmarking.
	//
	// This is used in the 1.0 release of gcp/observability, and thus must not be
	// deleted or changed.
	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.
	//
	// This is used in the 1.0 release of gcp/observability, and thus must not be
	// deleted or changed.
	AddGlobalDialOptions any // func(opt ...DialOption)
	// DisableGlobalDialOptions returns a DialOption that prevents the
	// ClientConn from applying the global DialOptions (set via
	// AddGlobalDialOptions).
	//
	// This is used in the 1.0 release of gcp/observability, and thus must not be
	// deleted or changed.
	DisableGlobalDialOptions any // func() grpc.DialOption
	// ClearGlobalDialOptions clears the array of extra DialOption. This
	// method is useful in testing and benchmarking.
	//
	// This is used in the 1.0 release of gcp/observability, and thus must not be
	// deleted or changed.
	ClearGlobalDialOptions func()
	// JoinDialOptions combines the dial options passed as arguments into a
	// single dial option.
	JoinDialOptions any // func(...grpc.DialOption) grpc.DialOption
	// JoinServerOptions combines the server options passed as arguments into a
	// single server option.
	JoinServerOptions any // func(...grpc.ServerOption) grpc.ServerOption

	// WithBinaryLogger returns a DialOption that specifies the binary logger
	// for a ClientConn.
	//
	// This is used in the 1.0 release of gcp/observability, and thus must not be
	// deleted or changed.
	WithBinaryLogger any // func(binarylog.Logger) grpc.DialOption
	// BinaryLogger returns a ServerOption that can set the binary logger for a
	// server.
	//
	// This is used in the 1.0 release of gcp/observability, and thus must not be
	// deleted or changed.
	BinaryLogger any // func(binarylog.Logger) grpc.ServerOption

	// SubscribeToConnectivityStateChanges adds a grpcsync.Subscriber to a provided grpc.ClientConn
	SubscribeToConnectivityStateChanges any // func(*grpc.ClientConn, grpcsync.Subscriber)

	// 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 any // 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()

	// ORCAAllowAnyMinReportingInterval is for examples/orca use ONLY.
	ORCAAllowAnyMinReportingInterval any // func(so *orca.ServiceOptions)

	// GRPCResolverSchemeExtraMetadata determines when gRPC will add extra
	// metadata to RPCs.
	GRPCResolverSchemeExtraMetadata string = "xds"

	// EnterIdleModeForTesting gets the ClientConn to enter IDLE mode.
	EnterIdleModeForTesting any // func(*grpc.ClientConn)

	// ExitIdleModeForTesting gets the ClientConn to exit IDLE mode.
	ExitIdleModeForTesting any // func(*grpc.ClientConn) error

	ChannelzTurnOffForTesting func()

	// TriggerXDSResourceNameNotFoundForTesting triggers the resource-not-found
	// error for a given resource type and name. This is usually triggered when
	// the associated watch timer fires. For testing purposes, having this
	// function makes events more predictable than relying on timer events.
	TriggerXDSResourceNameNotFoundForTesting any // func(func(xdsresource.Type, string), string, string) error

	// TriggerXDSResourceNameNotFoundClient invokes the testing xDS Client
	// singleton to invoke resource not found for a resource type name and
	// resource name.
	TriggerXDSResourceNameNotFoundClient any // func(string, string) error

	// FromOutgoingContextRaw returns the un-merged, intermediary contents of metadata.rawMD.
	FromOutgoingContextRaw any // func(context.Context) (metadata.MD, [][]string, bool)

	// UserSetDefaultScheme is set to true if the user has overridden the default resolver scheme.
	UserSetDefaultScheme bool = false
)

Functions

func NetDialerWithTCPKeepalive added in v1.60.0 

func NetDialerWithTCPKeepalive() *net.Dialer

NetDialerWithTCPKeepalive returns a net.Dialer that enables TCP keepalives on the underlying connection with OS default values for keepalive parameters.

TODO: Once https://github.com/golang/go/issues/62254 lands, and the appropriate Go version becomes less than our least supported Go version, we should look into using the new API to make things more straightforward.

Types

type HealthChecker added in v1.18.0 

type HealthChecker func(ctx context.Context, newStream func(string) (any, 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

View all Source files

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.
nop
Package nop implements a balancer with all of its balancer operations as no-ops, other than returning a Transient Failure Picker on a Client Conn update.
 Package nop implements a balancer with all of its balancer operations as no-ops, other than returning a Transient Failure Picker on a Client Conn update.
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 internal APIs for enabling channelz service, entry registration/deletion, and accessing channelz data.
 Package channelz defines internal 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 idle contains a component for managing idleness (entering and exiting) based on RPC activity.
 Package idle contains a component for managing idleness (entering and exiting) based on RPC activity.
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
grpc_lookup_v1
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.
dns/internal
Package internal contains functionality internal to the dns resolver package.
 Package internal contains functionality internal to the dns resolver package.
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/interop/grpc_testing for testing purposes.
 Package stubserver is a stubbable implementation of google.golang.org/grpc/interop/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.
xds/fakeserver
Package fakeserver provides a fake implementation of the management server.
 Package fakeserver provides a fake implementation of the management server.
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
Package xds contains methods to Get/Set handshake cluster names.
 Package xds contains methods to Get/Set handshake cluster names.
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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.