README.md

Balancer

Overview

This package contains a round-robin load balancer and a weighted round-robin load balancer. These can be used to balance load over any Go type. This was implemented to test the new Go 1.18 generics feature!

How to use this package

This package is very simple to use. Here is an example use case using a Round-robin balancer over a slice of string basic type elements.

package main

import (
	"fmt"
	"github.com/phonaputer/balancer"
)

func main() {
	elements := []string{"a", "b", "c"}
	
	roundRobin := balancer.NewRoundRobin(elements)
	
	fmt.Println(roundRobin.Next()) // prints "a"
	fmt.Println(roundRobin.Next()) // prints "b"
	fmt.Println(roundRobin.Next()) // prints "c"
	fmt.Println(roundRobin.Next()) // prints "a"
	fmt.Println(roundRobin.Next()) // prints "b"
	fmt.Println(roundRobin.Next()) // prints "c"
	// etc...
}

In addition, the Elements function can be used to get back the original slice passed to NewRoundRobin.

Please read the Godoc for this package for more details and for information about other kinds of balancers.

Copyright 2022 Phonaputer