dlm

Documentation

Index

• func Key(key string) string
• type Config
  • func (conf *Config) Validate() error
• type DistributedLockManager
• type Factory
  • func New(conf *Config) (Factory, error)
  • func NewRedlock(conf *Config) (Factory, error)
• type Option
  • func TimeToLive(ttl uint64) Option

Functions

func Key

func Key(key string) string

Types

type Config

type Config struct {
	Uri        string `json:"uri" yaml:"uri" mapstructure:"uri"`
	TimeToLive uint64 `json:"time_to_live" yaml:"time_to_live" mapstructure:"time_to_live"`
}

func (*Config) Validate

func (conf *Config) Validate() error

type DistributedLockManager

type DistributedLockManager interface {
	Lock(ctx context.Context) error
	Unlock(ctx context.Context) error
}

type Factory

type Factory func(key string, opts ...Option) DistributedLockManager

func New

func New(conf *Config) (Factory, error)

func NewRedlock

func NewRedlock(conf *Config) (Factory, error)

type Option

type Option func(*Config)

func TimeToLive

func TimeToLive(ttl uint64) Option