locker

Documentation

Index

• type Lock
  • func (l *Lock) Run(key string, timeout time.Duration, handler func())
• type Locker
  • func New(opts ...Option) Locker
• type Option
  • func Logger(l logger.Logger) Option
  • func Redis(r *redis.Client) Option
• type Options

Types

type Lock

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

Lock struct to abstract bsm/redis-lock

func (*Lock) Run

func (l *Lock) Run(key string, timeout time.Duration, handler func())

Run runs a callback handler with a Redis lock.

type Locker

type Locker interface {
	Run(key string, timeout time.Duration, handler func())
}

Locker interface to abstract bsm/redis-lock

func New

func New(opts ...Option) Locker

New creates instance of Locker

type Option

type Option func(*Options)

Option closure

func Logger

func Logger(l logger.Logger) Option

Logger closure to set field in Options

func Redis

func Redis(r *redis.Client) Option

Redis closure to set field in Options

type Options

type Options struct {
	Redis  *redis.Client
	Logger logger.Logger
}

Options for creating Locker instance