package base

Import Path
	google.golang.org/grpc/balancer/base (on go.dev)

Dependency Relation
	imports 6 packages, and imported by 3 packages

Involved Source Files

	      balancer.go
	   #d base.go
		Package base defines a balancer base that can be used to build balancers with
		different picking algorithms.

		The base balancer creates a new SubConn for each resolved address. The
		provided picker will only be notified about READY SubConns.

		This package is the base of round_robin balancer, its purpose is to be used
		to build round_robin like balancers with complex picking algorithms.
		Balancers with more complicated logic should try to implement a balancer
		builder from scratch.

		All APIs in this package are experimental.
Package-Level Type Names (total 7, in which 4 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Config (struct)
		Config contains the config info about the base balancer builder.

		Fields (only one, which is exported)
			HealthCheck bool
				HealthCheck indicates whether health checking should be enabled for this specific balancer.

		As Inputs Of (at least one exported)
			func NewBalancerBuilder(name string, pb PickerBuilder, config Config) balancer.Builder

	 type PickerBuilder (interface)
		PickerBuilder creates balancer.Picker.

		Methods (only one, which is exported)
			( PickerBuilder) Build(info PickerBuildInfo) balancer.Picker
				Build returns a picker that will be used by gRPC to pick a SubConn.

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*google.golang.org/grpc/balancer/roundrobin.rrPickerBuilder
		As Inputs Of (at least one exported)
			func NewBalancerBuilder(name string, pb PickerBuilder, config Config) balancer.Builder

	 type PickerBuildInfo (struct)
		PickerBuildInfo contains information needed by the picker builder to
		construct a picker.

		Fields (only one, which is exported)
			ReadySCs map[balancer.SubConn]SubConnInfo
				ReadySCs is a map from all ready SubConns to the Addresses used to
				create them.

		As Inputs Of (at least one exported)
			func PickerBuilder.Build(info PickerBuildInfo) balancer.Picker

	 type SubConnInfo (struct)
		SubConnInfo contains information about a SubConn created by the base
		balancer.

		Fields (only one, which is exported)
			Address resolver.Address
				// the address used to create this SubConn


	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type baseBalancer (struct)

		Fields (total 10, none are exported)
			/* 10 unexporteds ... *//* 10 unexporteds: */
			cc balancer.ClientConn
			config Config
			connErr error
				// the last connection error; cleared upon leaving TransientFailure

			csEvltr *balancer.ConnectivityStateEvaluator
			picker balancer.Picker
			pickerBuilder PickerBuilder
			resolverErr error
				// the last error reported by the resolver; cleared on successful resolution

			scStates map[balancer.SubConn]connectivity.State
			state connectivity.State
			subConns *resolver.AddressMap
		Methods (total 7, in which 5 are exported)
			(*baseBalancer) Close()
				Close is a nop because base balancer doesn't have internal state to clean up,
				and it doesn't need to call RemoveSubConn for the SubConns.

			(*baseBalancer) ExitIdle()
				ExitIdle is a nop because the base balancer attempts to stay connected to
				all SubConns at all times.

			(*baseBalancer) ResolverError(err error)
			(*baseBalancer) UpdateClientConnState(s balancer.ClientConnState) error
			(*baseBalancer) UpdateSubConnState(sc balancer.SubConn, state balancer.SubConnState)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*baseBalancer) mergeErrors() error
				mergeErrors builds an error from the last connection error and the last
				resolver error.  Must only be called if b.state is TransientFailure.

			(*baseBalancer) regeneratePicker()
				regeneratePicker takes a snapshot of the balancer, and generates a picker
				from it. The picker is
				  - errPicker if the balancer is in TransientFailure,
				  - built by the pickerBuilder with all READY SubConns otherwise.

		Implements (at least 2, both are exported)
			*baseBalancer : google.golang.org/grpc/balancer.Balancer
			*baseBalancer : google.golang.org/grpc/balancer.ExitIdler

	 type baseBuilder (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			config Config
			name string
			pickerBuilder PickerBuilder
		Methods (total 2, both are exported)
			(*baseBuilder) Build(cc balancer.ClientConn, opt balancer.BuildOptions) balancer.Balancer
			(*baseBuilder) Name() string
		Implements (at least one exported)
			*baseBuilder : google.golang.org/grpc/balancer.Builder

	 type errPicker (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			err error
				// Pick() always returns this err.

		Methods (only one, which is exported)
			(*errPicker) Pick(info balancer.PickInfo) (balancer.PickResult, error)
		Implements (at least one exported)
			*errPicker : google.golang.org/grpc/balancer.Picker


Package-Level Functions (total 2, both are exported)

	 func NewBalancerBuilder(name string, pb PickerBuilder, config Config) balancer.Builder
		NewBalancerBuilder returns a base balancer builder configured by the provided config.

	 func NewErrPicker(err error) balancer.Picker
		NewErrPicker returns a Picker that always returns err on Pick().


Package-Level Variables (total 2, in which 1 are exported)

	  var NewErrPickerV2 func(err error) balancer.Picker
		NewErrPickerV2 is temporarily defined for backward compatibility reasons.

		Deprecated: use NewErrPicker instead.

	/* one unexported ... *//* one unexported: */
	  var logger grpclog.DepthLoggerV2

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)