grpc: Index | Files | Directories

package internal

import ""

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.


Package Files



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"


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

type HealthChecker Uses

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:


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

Package internal imports 4 packages (graph) and is imported by 26 packages. Updated 2020-07-31. Refresh now. Tools for package owners.