ketama

Documentation

Index

• type Ketama
  • func New(opts ...Option) *Ketama
  • func (k *Ketama) Add(nodes ...string)
  • func (k *Ketama) Empty() bool
  • func (k *Ketama) Get(key string) (string, bool)
  • func (k *Ketama) Remove(nodes ...string)
• type Option
  • func WithGoroutineSafe() Option
  • func WithReplicas(replicas int) Option
• type Options

Types

type Ketama

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

Ketama is an implementation of consistent-hash

func New

func New(opts ...Option) *Ketama

New creates a new ketama

func (*Ketama) Add

func (k *Ketama) Add(nodes ...string)

Add adds nodes to the ketama ring

func (*Ketama) Empty

func (k *Ketama) Empty() bool

Empty returns true if the ketama is empty, otherwise returns false

func (*Ketama) Get

func (k *Ketama) Get(key string) (string, bool)

Get returns the node closest to key in the clockwise direction

func (*Ketama) Remove

func (k *Ketama) Remove(nodes ...string)

Remove removes nodes from the ketama ring

type Option

type Option func(option *Options)

Option is a function type used to set Options

func WithGoroutineSafe

func WithGoroutineSafe() Option

WithGoroutineSafe is used to config a Ketama with goroutine-safe

func WithReplicas

func WithReplicas(replicas int) Option

WithReplicas is used to config the hash replicas of a Ketama

type Options

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

Options hold Ketama's options