valkey

Documentation

Index

• func NewValkeyLoadbalancer(opt valkey.ClientOption) (valkey.Client, *loadbalancer, error)
• type ValkeyBackend
  • func NewValkeyBackend(cfg ValkeyConfig) (*ValkeyBackend, error)
  • func (r *ValkeyBackend) Close() error
  • func (r *ValkeyBackend) GetLocks(group string) (int, error)
  • func (r *ValkeyBackend) GetStaleLocks(ts time.Duration) ([]types.Lock, error)
  • func (r *ValkeyBackend) HasLock(group string, id string) (bool, error)
  • func (r *ValkeyBackend) Release(group string, id string) error
  • func (r *ValkeyBackend) Reserve(group string, id string) error
• type ValkeyConfig
• type ValkeySentinelConfig

Functions

func NewValkeyLoadbalancer

func NewValkeyLoadbalancer(opt valkey.ClientOption) (valkey.Client, *loadbalancer, error)

Create a new valkey client with loadbalanced connections

Types

type ValkeyBackend

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

func NewValkeyBackend

func NewValkeyBackend(cfg ValkeyConfig) (*ValkeyBackend, error)

func (*ValkeyBackend) Close

func (r *ValkeyBackend) Close() error

Calls all necessary finalization if necessary

func (*ValkeyBackend) GetLocks

func (r *ValkeyBackend) GetLocks(group string) (int, error)

Returns the current number of locks for the given group

func (*ValkeyBackend) GetStaleLocks

func (r *ValkeyBackend) GetStaleLocks(ts time.Duration) ([]types.Lock, error)

Return all locks older than x

func (*ValkeyBackend) HasLock

func (r *ValkeyBackend) HasLock(group string, id string) (bool, error)

Check if a given id already has a lock for this group

func (*ValkeyBackend) Release

func (r *ValkeyBackend) Release(group string, id string) error

Release the lock currently held by the id. Does not fail when no lock is held.

func (*ValkeyBackend) Reserve

func (r *ValkeyBackend) Reserve(group string, id string) error

Reserve a lock for the given group. Returns true if the lock is successfully reserved, even if the lock is already held by the specific id

type ValkeyConfig

type ValkeyConfig struct {
	Addrs    []string             `yaml:"addresses,omitempty"`
	Username string               `yaml:"username,omitempty"`
	Password string               `yaml:"password,omitempty"`
	DB       int                  `yaml:"db,omitempty"`
	TLS      bool                 `yaml:"tls,omitempty"`
	Sentinel ValkeySentinelConfig `yaml:"sentinel,omitempty"`
}

type ValkeySentinelConfig

type ValkeySentinelConfig struct {
	Enabled    bool     `yaml:"enabled,omitempty"`
	MasterName string   `yaml:"master,omitempty"`
	Addresses  []string `yaml:"addresses,omitempty"`
	Username   string   `yaml:"username,omitempty"`
	Password   string   `yaml:"password,omitempty"`
}