picker

Documentation

Overview

Package picker defines/implements client balancer picker policy.

Index

• type Picker
  • func NewErr(err error) Picker
  • func NewRoundrobinBalanced(lg *zap.Logger, scs []balancer.SubConn, ...) Picker
• type Policy
  • func (p Policy) String() string

Types

type Picker

type Picker interface {
	balancer.Picker
}

Picker defines balancer Picker methods.

func NewErr

func NewErr(err error) Picker

NewErr returns a picker that always returns err on "Pick".

func NewRoundrobinBalanced

func NewRoundrobinBalanced(
	lg *zap.Logger,
	scs []balancer.SubConn,
	addrToSc map[resolver.Address]balancer.SubConn,
	scToAddr map[balancer.SubConn]resolver.Address,
) Picker

NewRoundrobinBalanced returns a new roundrobin balanced picker.

type Policy

type Policy uint8

Policy defines balancer picker policy.

const (

	// RoundrobinBalanced balance loads over multiple endpoints
	// and implements failover in roundrobin fashion.
	RoundrobinBalanced Policy = iota
)

func (Policy) String

func (p Policy) String() string