roundrobin

README

roundrobin

roundrobin with configurable rotating strategies - inspired by https://github.com/hlts2/round-robin

Documentation

Index

• Variables
• type Item
  • func (i Item) String() string
• type Options
• type RoundRobin
  • func New(items ...string) (*RoundRobin, error)
  • func NewWithOptions(options Options, items ...string) (*RoundRobin, error)
  • func (r *RoundRobin) Add(items ...string)
  • func (r *RoundRobin) Next() Item
• type Stats
  • func (s *Stats) Inc(value int32)
  • func (s *Stats) Reset()

Variables

var DefaultOptions = Options{
	RotateAmount: 1,
}

var ErrNoItems = errors.New("no items")

ErrNoItems specified for the algorithm

Types

type Item

type Item struct {
	Stats Stats
	// contains filtered or unexported fields
}

func (Item) String

func (i Item) String() string

type Options

type Options struct {
	RotateAmount int32
}

type RoundRobin

type RoundRobin struct {
	Options Options
	// contains filtered or unexported fields
}

RoundRobin iterates over the items in a round robin fashion

func New

func New(items ...string) (*RoundRobin, error)

New returns a new RoundRobin structure

func NewWithOptions

func NewWithOptions(options Options, items ...string) (*RoundRobin, error)

New returns a new RoundRobin structure with custom options

func (*RoundRobin) Add

func (r *RoundRobin) Add(items ...string)

Next returns next item

func (*RoundRobin) Next

func (r *RoundRobin) Next() Item

Next returns next item

type Stats

type Stats struct {
	Count int32
}

func (*Stats) Inc

func (s *Stats) Inc(value int32)

func (*Stats) Reset

func (s *Stats) Reset()