ringhash

Documentation

Overview

Package ringhash implements the ringhash balancer.

Index

• Constants
• func SetXDSRequestHash(ctx context.Context, requestHash uint64) context.Context
• func XDSRequestHash(ctx context.Context) (uint64, bool)
• type LBConfig

Constants

const Name = "ring_hash_experimental"

Name is the name of the ring_hash balancer.

Functions

func SetXDSRequestHash

func SetXDSRequestHash(ctx context.Context, requestHash uint64) context.Context

SetXDSRequestHash adds the request hash to the context for use in Ring Hash Load Balancing using xDS route hash_policy.

func XDSRequestHash

func XDSRequestHash(ctx context.Context) (uint64, bool)

XDSRequestHash returns the request hash in the context and true if it was set from the xDS config selector. If the xDS config selector has not set the hash, it returns 0 and false.

Types

type LBConfig

type LBConfig struct {
	serviceconfig.LoadBalancingConfig `json:"-"`

	MinRingSize       uint64 `json:"minRingSize,omitempty"`
	MaxRingSize       uint64 `json:"maxRingSize,omitempty"`
	RequestHashHeader string `json:"requestHashHeader,omitempty"`
}

LBConfig is the balancer config for ring_hash balancer.