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

# Packages

Package base defines a balancer base that can be used to build balancers with different picking algorithms.
Package endpointsharding implements a load balancing policy that manages homogeneous child policies each owning a single endpoint.
Package grpclb defines a grpclb balancer.
Package lazy contains a load balancer that starts in IDLE instead of CONNECTING.
Package leastrequest implements a least request load balancer.
Package pickfirst contains the pick_first load balancing policy.
Package rls implements the RLS LB policy.
Package roundrobin defines a roundrobin balancer.
Package weightedroundrobin provides an implementation of the weighted round robin LB policy, as defined in [gRFC A58].
Package weightedtarget implements the weighted_target balancer.

# Functions

Get returns the resolver builder registered with the given name.
Register registers the balancer builder to the balancer map.
TransientFailureError returns e.

# Variables

ErrBadResolverState may be returned by UpdateClientConnState to indicate a problem with the provided name resolver data.
ErrNoSubConnAvailable indicates no SubConn is available for pick().
ErrTransientFailure indicates all SubConns are in TransientFailure.

# Structs

BuildOptions contains additional information for Build.
ClientConnState describes the state of a ClientConn relevant to the balancer.
ConnectivityStateEvaluator takes the connectivity states of multiple SubConns and returns one aggregated connectivity state.
DoneInfo contains additional information for done.
NewSubConnOptions contains options to create new SubConn.
PickInfo contains additional information for the Pick operation.
PickResult contains information related to a connection chosen for an RPC.
State contains the balancer's state relevant to the gRPC ClientConn.
SubConnState describes the state of a SubConn.

# Interfaces

Balancer takes input from gRPC, manages SubConns, and collects and aggregates the connectivity states.
Builder creates a balancer.
ClientConn represents a gRPC ClientConn.
ConfigParser parses load balancer configs.
ExitIdler is an optional interface for balancers to implement.
Picker is used by gRPC to pick a SubConn to send an RPC.
A ProducerBuilder is a simple constructor for a Producer.
A SubConn represents a single connection to a gRPC backend service.

# Type aliases

A Producer is a type shared among potentially many consumers.