balancer

Documentation

Overview

Package balancer provides a balancer interface and builder, which is used to forward the request to one of the backend endpoints by the specific policy.

Index

• func Policies() []string
• func Register(balancer Balancer)
• func Unregister(policy string)
• type Balancer
  • func Get(policy string) Balancer
  • func Gets() []Balancer
• type Forwarder

Functions

func Policies

func Policies() []string

Policies returns the policies of all the registered balancers.

func Register

func Register(balancer Balancer)

Register registers the balancer.

Some balancers has been registered by default, as follow:

random
roundrobin
weight_random
weight_roundrobin
sourceip_hash
leastconn

If exists, override it.

func Unregister

func Unregister(policy string)

Unregister unregisters the balancer by the policy.

If not exist, do nothing.

Types

type Balancer

type Balancer interface {
	Policy() string
	Forwarder
}

Balancer does a balancer to forward the request to one of the backend endpoints by the specific policy.

var DefaultBalancer Balancer = roundrobin.NewBalancer("")

DefaultBalancer is the default balancer.

func Get

func Get(policy string) Balancer

Get returns the registered balancer by the policy.

If not exist, return nil.

func Gets

func Gets() []Balancer

Gets returns all the registered balancers.

type Forwarder

type Forwarder interface {
	Forward(ctx context.Context, req any, eps *loadbalancer.Static) (any, error)
}

Forwarder is used to forward the request to one of the backend endpoints.