balancer

Documentation

Overview

Package balancer implements a capacity based load balancer where each entity periodically reports its actual processing capacity and the balancer issues requests based on those numbers.

Index

• type Balancer
  • func New() *Balancer
  • func (b *Balancer) Balance(ex *big.Int) (*big.Int, error)
  • func (b *Balancer) Capacity(ex *big.Int) int
  • func (b *Balancer) Register(id *big.Int)
  • func (b *Balancer) Unregister(id *big.Int)
  • func (b *Balancer) Update(id *big.Int, cap int) error

Types

type Balancer

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

The load balancer for a single topic.

func New

func New() *Balancer

Creates a new - empty - load balancer.

func (*Balancer) Balance

func (b *Balancer) Balance(ex *big.Int) (*big.Int, error)

Returns an id to which to send the next message to. The optional ex (can be nil) is used to exclude an entity from balancing to (if it's the only one available then this guarantee will be forfeit).

func (*Balancer) Capacity

func (b *Balancer) Capacity(ex *big.Int) int

Returns the total capacity that the balancer can handle, optionally with ex excluded from the count.

func (*Balancer) Register

func (b *Balancer) Register(id *big.Int)

Registers an entity to load balance to (no duplicate checks are done).

func (*Balancer) Unregister

func (b *Balancer) Unregister(id *big.Int)

Unregisters an entity from the possible balancing destinations.

func (*Balancer) Update

func (b *Balancer) Update(id *big.Int, cap int) error

Updates an entry's capacity to cap.