grpc: Index | Files

package base

import ""

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 Files

balancer.go base.go

func NewBalancerBuilder Uses

func NewBalancerBuilder(name string, pb PickerBuilder) balancer.Builder

NewBalancerBuilder returns a balancer builder. The balancers built by this builder will use the picker builder to build pickers.

func NewBalancerBuilderWithConfig Uses

func NewBalancerBuilderWithConfig(name string, pb PickerBuilder, config Config) balancer.Builder

NewBalancerBuilderWithConfig returns a base balancer builder configured by the provided config.

func NewErrPicker Uses

func NewErrPicker(err error) balancer.Picker

NewErrPicker returns a picker that always returns err on Pick().

type Config Uses

type Config struct {
    // HealthCheck indicates whether health checking should be enabled for this specific balancer.
    HealthCheck bool

Config contains the config info about the base balancer builder.

type PickerBuilder Uses

type PickerBuilder interface {
    // Build takes a slice of ready SubConns, and returns a picker that will be
    // used by gRPC to pick a SubConn.
    Build(readySCs map[resolver.Address]balancer.SubConn) balancer.Picker

PickerBuilder creates balancer.Picker.

Package base imports 5 packages (graph) and is imported by 8 packages. Updated 2019-10-05. Refresh now. Tools for package owners.