package
1.72.0-dev
Repository: https://github.com/grpc/grpc-go.git
Documentation: pkg.go.dev

# Packages

Package admin contains internal implementation for admin service.
Package backoff implement the backoff strategy for gRPC.
No description provided by the author
Package balancergroup implements a utility struct to bind multiple balancers into one balancer.
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 buffer provides an implementation of an unbounded buffer.
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 credentials defines APIs for parsing SPIFFE ID.
Package envconfig contains grpc settings configured by environment variables.
Package googlecloud contains internal helpful functions for google cloud.
Package grpclog provides logging functionality for internal gRPC packages, outside of the functionality provided by the external `grpclog` package.
Package grpcsync implements additional synchronization primitives built upon the sync package.
Package grpctest implements testing helpers.
Package grpcutil provides utility functions used across the gRPC codebase.
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 leakcheck contains functions to check leaked goroutines and buffers.
Package metadata contains functions to set and get metadata from addresses.
Package pretty defines helper functions to pretty-print structs for logging.
Package profiling contains two logical components: buffer.go and profiling.go.
No description provided by the author
Package proxyattributes contains functions for getting and setting proxy attributes like the CONNECT address and user info.
Package resolver provides internal resolver-related functionality.
Package serviceconfig contains utility functions to parse service config.
Package stats provides internal stats related functionality.
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 syscall provides functionalities that grpc uses to get low-level operating system stats/info.
Package testutils contains testing helpers.
Package transport defines and implements message oriented communication channel to complete various transactions (e.g., an RPC).
Package wrr contains the interface and common implementations of wrr algorithms.
Package xds contains methods to Get/Set handshake cluster names.

# Functions

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

# Constants

CredsBundleModeBackendFromBalancer switches GoogleDefaultCreds to mode that supports backend returned by grpclb balancer.
CredsBundleModeBalancer switches GoogleDefaultCreds to grpclb balancer mode.
CredsBundleModeFallback switches GoogleDefaultCreds to fallback mode.
RLSLoadBalancingPolicyName is the name of the RLS LB policy.

# Variables

func(opt ...DialOption).
func (opt any).
func(opt ...ServerOption).
BalancerUnregister is exported by package balancer to unregister a balancer.
func(binarylog.Logger) grpc.ServerOption.
func (grpc.SharedBufferPool) grpc.ServerOption.
func (codes.Code) string.
ChannelzTurnOffForTesting disables the Channelz service for testing purposes.
ClearGlobalDialOptions clears the array of extra DialOption.
ClearGlobalPerTargetDialOptions clears the slice of global late apply dial options.
ClearGlobalServerOptions clears the array of extra ServerOption.
func (scs SubConnState) resolver.Address.
func() grpc.DialOption.
func(*grpc.ClientConn).
EqualServiceConfigForTesting is for testing service config generation and parsing.
func(*grpc.ClientConn) error.
func(context.Context) (metadata.MD, [][]string, bool).
func(string) certprovider.Builder.
func (*grpc.Server) credentials.TransportCredentials.
func (*attributes.Attributes) *unsafe.Pointer.
GRPCResolverSchemeExtraMetadata determines when gRPC will add extra metadata to RPCs.
HealthCheckFunc is used to provide client-side LB channel health checking.
func(*grpc.Server, string) bool.
func(...grpc.DialOption) grpc.DialOption.
func(...grpc.ServerOption) grpc.ServerOption.
KeepaliveMinPingTime is the minimum ping interval.
KeepaliveMinServerPingTime is the minimum ping interval for servers.
func (*grpc.Server) estats.MetricsRecorder.
func(xdsclient.XDSClient) (resolver.Builder, error).
func([]byte) (resolver.Builder, error).
func(*xdsclient.Pool) (resolver.Builder, error).
func(so *orca.ServiceOptions).
func(string) *serviceconfig.ParseResult.
func(ctx context.Context, sc balancer.SubConn, serviceName string, listener func(balancer.SubConnState)) func().
RegisterRBACHTTPFilterForTesting registers the RBAC HTTP Filter for testing purposes, regardless of the RBAC environment variable.
RegisterRLSClusterSpecifierPluginForTesting registers the RLS Cluster Specifier Plugin for testing purposes, regardless of the XDSRLS environment variable.
func(context.Context) *grpc.Server.
func(int).
func(scs *SubConnState, addr resolver.Address).
func(mem.BufferPool).
SnapshotMetricRegistryForTesting snapshots the global data of the metric registry.
func(*grpc.ClientConn, grpcsync.Subscriber).
func(xdsclient.XDSClient, xdsresource.Type, string) error.
UnregisterRBACHTTPFilterForTesting unregisters the RBAC HTTP Filter for testing purposes.
UnregisterRLSClusterSpecifierPluginForTesting unregisters the RLS Cluster Specifier Plugin for testing purposes.
UserSetDefaultScheme is set to true if the user has overridden the default resolver scheme.
func(binarylog.Logger) grpc.DialOption.
func (grpc.SharedBufferPool) grpc.DialOption.

# Interfaces

EnforceClientConnEmbedding is used to enforce proper ClientConn implementation embedding.
EnforceSubConnEmbedding is used to enforce proper SubConn implementation embedding.

# Type aliases

HealthChecker defines the signature of the client-side LB channel health checking function.