Categorygithub.com/smallnest/weighted
modulepackage
0.0.0-20230419055410-36b780e40a7a
Repository: https://github.com/smallnest/weighted.git
Documentation: pkg.go.dev

# README

License GoDoc travis coveralls Go Report Card

rust version: weighted-rs

Package weighted implements the smooth weighted round-robin balancing algorithm. This algorithm is implemented in Nginx: https://github.com/phusion/nginx/commit/27e94984486058d73157038f7950a0a36ecc6e35.

Notice: The weighted is NOT goroutine-safe so you MUST use the synchronization primitive to protect it (the Next method) in concurrent cases.

Algorithm is as follows: on each peer selection we increase current_weight of each eligible peer by its weight, select peer with greatest current_weight and reduce its current_weight by total number of weight points distributed among peers.

In case of { 5, 1, 1 } weights this gives the following sequence of current_weight's: (a, a, b, a, c, a, a)

This is an example to use it:

package main

import "fmt"

func ExampleSW_Next() {
	w := &SW{}
	w.Add("a", 5)
	w.Add("b", 2)
	w.Add("c", 3)

	for i := 0; i < 10; i++ {
		fmt.Printf("%s ", w.Next())
	}
}

And this lib has provides another weighted round robin algorithm. This algorithm is used in LVS. It has better performance but it is not so more smooth than the first algorithm, so you can select one algorithm according to your case. It is used like the first:

package main

import "fmt"

func ExampleRRW_Next() {
	w := &RRW{}
	w.Add("a", 5)
	w.Add("b", 2)
	w.Add("c", 3)

	for i := 0; i < 10; i++ {
		fmt.Printf("%s ", w.Next())
	}
}

# Functions

NewRandW creates a new RandW with a random object.

# Structs

RandW is a struct that contains weighted items implement weighted random algorithm.
RRW is a struct that contains weighted items implement LVS weighted round robin algorithm.
SW (Smooth Weighted) is a struct that contains weighted items and provides methods to select a weighted item.

# Interfaces

W is a interface that implement a weighted round robin algorithm.