dlm

Documentation

Index

• type DLM
• type RedisDLM
  • func NewRedisDLM(prefix string, opts *goredislib.Options) *RedisDLM
  • func (r *RedisDLM) Lock(name string, expiry time.Duration) error
  • func (r *RedisDLM) Unlock(name string) (bool, error)

Types

type DLM

type DLM interface {
	// Lock locks a given name until the expiry duration has passed or Unlock is called
	Lock(name string, expiry time.Duration) error
	// Unlock removes a lock from a given name
	Unlock(name string) (bool, error)
}

DLM Distributed Lock Manager interface

type RedisDLM

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

RedisDLM is a Redis backed implementation of the Distributed Lock Manager interface

func NewRedisDLM

func NewRedisDLM(prefix string, opts *goredislib.Options) *RedisDLM

NewRedisDLM is a helper function for creating a RedisDLM

func (*RedisDLM) Lock

func (r *RedisDLM) Lock(name string, expiry time.Duration) error

Lock locks a given name until the expiry duration has passed or Unlock is called

func (*RedisDLM) Unlock

func (r *RedisDLM) Unlock(name string) (bool, error)

Unlock removes a lock from a given name