load_balancer

README

Copy from https://github.com/liyue201/grpc-lb

Documentation

Index

• Constants
• Variables
• func NewBalancer(r naming.Resolver, selector Selector) grpc.Balancer
• type AddrInfo
• type HashFunc
• type Ketama
  • func NewKetama(replicas int, fn HashFunc) *Ketama
  • func (h *Ketama) Add(nodes ...string)
  • func (h *Ketama) Get(key string) (string, bool)
  • func (h *Ketama) IsEmpty() bool
  • func (h *Ketama) Remove(nodes ...string)
• type KetamaSelector
  • func (s *KetamaSelector) Add(addr grpc.Address) error
  • func (b *KetamaSelector) AddrList() []grpc.Address
  • func (s *KetamaSelector) Delete(addr grpc.Address) error
  • func (b *KetamaSelector) Down(addr grpc.Address) error
  • func (s *KetamaSelector) Get(ctx context.Context) (addr grpc.Address, err error)
  • func (b *KetamaSelector) Put(addr string) error
  • func (b *KetamaSelector) Up(addr grpc.Address) (cnt int, connected bool)
• type RandomSelector
  • func (b *RandomSelector) Add(addr grpc.Address) error
  • func (b *RandomSelector) AddrList() []grpc.Address
  • func (b *RandomSelector) Delete(addr grpc.Address) error
  • func (b *RandomSelector) Down(addr grpc.Address) error
  • func (r *RandomSelector) Get(ctx context.Context) (addr grpc.Address, err error)
  • func (b *RandomSelector) Put(addr string) error
  • func (b *RandomSelector) Up(addr grpc.Address) (cnt int, connected bool)
• type RoundRobinSelector
  • func (b *RoundRobinSelector) Add(addr grpc.Address) error
  • func (b *RoundRobinSelector) AddrList() []grpc.Address
  • func (b *RoundRobinSelector) Delete(addr grpc.Address) error
  • func (b *RoundRobinSelector) Down(addr grpc.Address) error
  • func (r *RoundRobinSelector) Get(ctx context.Context) (addr grpc.Address, err error)
  • func (b *RoundRobinSelector) Put(addr string) error
  • func (b *RoundRobinSelector) Up(addr grpc.Address) (cnt int, connected bool)
• type Selector
  • func NewKetamaSelector(ketamaKey string) Selector
  • func NewRandomSelector() Selector
  • func NewRoundRobinSelector() Selector

Constants

const (
	DefaultReplicas = 10
)

Variables

var (
	DefaultKetamaKey  = "grpc-lb-ketama-key"
	KetamaKeyEmptyErr = errors.New("ketama key is empty")
)

var AddrDoseNotExistErr = errors.New("addr does not exist")

var AddrExistErr = errors.New("addr exist")

var AddrListEmptyErr = errors.New("addr list is emtpy")

var DefaultSelector = NewRandomSelector()

var NoAvailableAddressErr = errors.New("no available address")

Functions

func NewBalancer

func NewBalancer(r naming.Resolver, selector Selector) grpc.Balancer

Types

type AddrInfo

type AddrInfo struct {
	// contains filtered or unexported fields
}

type HashFunc

type HashFunc func(data []byte) uint32

type Ketama

type Ketama struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewKetama

func NewKetama(replicas int, fn HashFunc) *Ketama

func (*Ketama) Add

func (h *Ketama) Add(nodes ...string)

func (*Ketama) Get

func (h *Ketama) Get(key string) (string, bool)

func (*Ketama) IsEmpty

func (h *Ketama) IsEmpty() bool

func (*Ketama) Remove

func (h *Ketama) Remove(nodes ...string)

type KetamaSelector

type KetamaSelector struct {
	// contains filtered or unexported fields
}

func (*KetamaSelector) Add

func (s *KetamaSelector) Add(addr grpc.Address) error

func (*KetamaSelector) AddrList

func (b *KetamaSelector) AddrList() []grpc.Address

func (*KetamaSelector) Delete

func (s *KetamaSelector) Delete(addr grpc.Address) error

func (*KetamaSelector) Down

func (b *KetamaSelector) Down(addr grpc.Address) error

func (*KetamaSelector) Get

func (s *KetamaSelector) Get(ctx context.Context) (addr grpc.Address, err error)

func (*KetamaSelector) Put

func (b *KetamaSelector) Put(addr string) error

func (*KetamaSelector) Up

func (b *KetamaSelector) Up(addr grpc.Address) (cnt int, connected bool)

type RandomSelector

type RandomSelector struct {
	// contains filtered or unexported fields
}

func (*RandomSelector) Add

func (b *RandomSelector) Add(addr grpc.Address) error

func (*RandomSelector) AddrList

func (b *RandomSelector) AddrList() []grpc.Address

func (*RandomSelector) Delete

func (b *RandomSelector) Delete(addr grpc.Address) error

func (*RandomSelector) Down

func (b *RandomSelector) Down(addr grpc.Address) error

func (*RandomSelector) Get

func (r *RandomSelector) Get(ctx context.Context) (addr grpc.Address, err error)

func (*RandomSelector) Put

func (b *RandomSelector) Put(addr string) error

func (*RandomSelector) Up

func (b *RandomSelector) Up(addr grpc.Address) (cnt int, connected bool)

type RoundRobinSelector

type RoundRobinSelector struct {
	// contains filtered or unexported fields
}

func (*RoundRobinSelector) Add

func (b *RoundRobinSelector) Add(addr grpc.Address) error

func (*RoundRobinSelector) AddrList

func (b *RoundRobinSelector) AddrList() []grpc.Address

func (*RoundRobinSelector) Delete

func (b *RoundRobinSelector) Delete(addr grpc.Address) error

func (*RoundRobinSelector) Down

func (b *RoundRobinSelector) Down(addr grpc.Address) error

func (*RoundRobinSelector) Get

func (r *RoundRobinSelector) Get(ctx context.Context) (addr grpc.Address, err error)

func (*RoundRobinSelector) Put

func (b *RoundRobinSelector) Put(addr string) error

func (*RoundRobinSelector) Up

func (b *RoundRobinSelector) Up(addr grpc.Address) (cnt int, connected bool)

type Selector

type Selector interface {
	Add(addr grpc.Address) error
	Delete(addr grpc.Address) error
	Up(addr grpc.Address) (cnt int, connected bool)
	Down(addr grpc.Address) error
	AddrList() []grpc.Address
	Get(ctx context.Context) (grpc.Address, error)
	Put(addr string) error
}

func NewKetamaSelector

func NewKetamaSelector(ketamaKey string) Selector

func NewRandomSelector

func NewRandomSelector() Selector

func NewRoundRobinSelector

func NewRoundRobinSelector() Selector