balancer

Documentation

Index

• Constants
• type Balancer
  • func (b *Balancer) Close()
  • func (b *Balancer) ResolverError(err error)
  • func (b *Balancer) UpdateClientConnState(s balancer.ClientConnState) error
  • func (b *Balancer) UpdateSubConnState(sc balancer.SubConn, state balancer.SubConnState)
• type Builder
  • func NewBuilder(fn consistent.Hasher) Builder
• type Config
  • func (c *Config) ServiceConfigJSON() (string, error)
• type ConsistentMember
  • func (s ConsistentMember) String() string

Constants

const (
	Name = "consistenthashing" // Name of the balancer.
	Key  = "consistenthashkey" // Key for the consistent hash.
)

Package-level constants for the balancer name and consistent hash key.

Types

type Balancer

type Balancer struct {
	// contains filtered or unexported fields
}

func (*Balancer) Close

func (b *Balancer) Close()

func (*Balancer) ResolverError

func (b *Balancer) ResolverError(err error)

func (*Balancer) UpdateClientConnState

func (b *Balancer) UpdateClientConnState(s balancer.ClientConnState) error

func (*Balancer) UpdateSubConnState

func (b *Balancer) UpdateSubConnState(sc balancer.SubConn, state balancer.SubConnState)

type Builder

type Builder interface {
	balancer.Builder      // Interface for building balancers.
	balancer.ConfigParser // Interface for parsing balancer configurations.
}

Builder defines the interface for the consistent hashing balancer builder.

func NewBuilder

func NewBuilder(fn consistent.Hasher) Builder

NewBuilder initializes a new builder with the given hashing function.

type Config

type Config struct {
	serviceconfig.LoadBalancingConfig `json:"-"` // Embedding the base load balancing config.
	PartitionCount                    int        `json:"partitionCount,omitempty"`    // Number of partitions in the consistent hash ring.
	ReplicationFactor                 int        `json:"replicationFactor,omitempty"` // Number of replicas for each member.
	Load                              float64    `json:"load,omitempty"`              // Load factor for balancing traffic.
	PickerWidth                       int        `json:"pickerWidth,omitempty"`       // Number of closest members to consider in the picker.
}

Config represents the configuration for the consistent hashing balancer.

func (*Config) ServiceConfigJSON

func (c *Config) ServiceConfigJSON() (string, error)

ServiceConfigJSON generates the JSON representation of the load balancer configuration.

type ConsistentMember

type ConsistentMember struct {
	balancer.SubConn // Embedded SubConn for the gRPC connection.
	// contains filtered or unexported fields
}

ConsistentMember represents a member in the consistent hashing ring.

func (ConsistentMember) String

func (s ConsistentMember) String() string

String returns the name of the ConsistentMember.