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

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
	// NewRequestInfoContext creates a new context based on the argument context attaching
	// the passed in RequestInfo to the new context.
	NewRequestInfoContext interface{} // func(context.Context, credentials.RequestInfo) context.Context
	// NewClientHandshakeInfoContext returns a copy of the input context with
	// the passed in ClientHandshakeInfo struct added to it.
	NewClientHandshakeInfoContext interface{} // func(context.Context, credentials.ClientHandshakeInfo) context.Context
	// 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
)

Functions

This section is empty.

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

Directories

Path Synopsis
backoff Package backoff implement the backoff strategy for gRPC.
balancer/stub Package stub implements a balancer for testing purposes.
balancerload Package balancerload defines APIs to parse server loads in trailers.
binarylog Package binarylog implementation binary logging as defined in https://github.com/grpc/proposal/blob/master/A16-binary-logging.md.
buffer Package buffer provides an implementation of an unbounded buffer.
cache Package cache implements caches to be used in gRPC.
channelz Package channelz defines APIs for enabling channelz service, entry registration/deletion, and accessing channelz data.
credentials Package credentials defines APIs for parsing SPIFFE ID.
envconfig Package envconfig contains grpc settings configured by environment variables.
grpclog Package grpclog (internal) defines depth logging for grpc.
grpcrand Package grpcrand implements math/rand functions in a concurrent-safe way with a global random source, independent of math/rand's global source.
grpcsync Package grpcsync implements additional synchronization primitives built upon the sync package.
grpctest Package grpctest implements testing helpers.
grpcutil Package grpcutil provides a bunch of utility functions to be used across the gRPC codebase.
hierarchy Package hierarchy contains functions to set and get hierarchy string from addresses.
leakcheck Package leakcheck contains functions to check leaked goroutines.
profiling Package profiling contains two logical components: buffer.go and profiling.go.
profiling/buffer Package buffer provides a high-performant lock free implementation of a circular buffer used by the profiling code.
proto/grpc_service_config
resolver/dns Package dns implements a dns resolver to be installed as the default resolver in grpc.
resolver/passthrough Package passthrough implements a pass-through resolver.
serviceconfig Package serviceconfig contains utility functions to parse service config.
status Package status implements errors returned by gRPC.
syscall Package syscall provides functionalities that grpc uses to get low-level operating system stats/info.
testutils Package testutils contains testing helpers.
transport Package transport defines and implements message oriented communication channel to complete various transactions (e.g., an RPC).
wrr Package wrr contains the interface and common implementations of wrr algorithms.