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
	// StatusRawProto is exported by status/status.go. This func returns a
	// pointer to the wrapped Status proto for a given status.Status without a
	// call to proto.Clone(). The returned Status proto should not be mutated by
	// the caller.
	StatusRawProto interface{} // func (*status.Status) *spb.Status
	// 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
	// ParseServiceConfigForTesting is for creating a fake
	// ClientConn for resolver testing only
	ParseServiceConfigForTesting interface{} // func(string) *serviceconfig.ParseResult
)

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

Directories

PathSynopsis
internal/backoffPackage backoff implement the backoff strategy for gRPC.
internal/balancerloadPackage balancerload defines APIs to parse server loads in trailers.
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/envconfigPackage envconfig contains grpc settings configured by environment variables.
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/grpctest/tloggerPackage tlogger initializes the testing logger on import which logs to the testing package's T struct.
internal/leakcheckPackage leakcheck contains functions to check leaked goroutines.
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/resolver
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/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/wrr
Version
v1.28.0-pre
Published
Jan 28, 2020
Platform
linux/amd64
Imports
3 packages
Last checked
58 minutes ago

Tools for package owners.