sync

README

sync

distributed sync lock

Documentation

Index

• Variables
• type Mutexer
• type OptionFunc
  • func KeyPrefix(prefix string) OptionFunc
  • func LockTimeout(duration time.Duration) OptionFunc
  • func WaitRetry(duration time.Duration) OptionFunc
• type Options
• type RedisSync
  • func NewRedisSync(client *redis.Client, opts ...OptionFunc) *RedisSync
  • func (s *RedisSync) NewMutex(key string, opts ...OptionFunc) Mutexer

Variables

var (
	ErrLockFailed   = errors.New("lock failed")
	ErrUnlockFailed = errors.New("unlock failed")
)

Types

type Mutexer

type Mutexer interface {
	Lock() (err error)
	Unlock() (err error)
}

type OptionFunc

type OptionFunc func(o *Options)

func KeyPrefix

func KeyPrefix(prefix string) OptionFunc

func LockTimeout

func LockTimeout(duration time.Duration) OptionFunc

func WaitRetry

func WaitRetry(duration time.Duration) OptionFunc

type Options

type Options struct {
	KeyPrefix   string
	LockTimeout time.Duration
	WaitRetry   time.Duration
}

type RedisSync

type RedisSync struct {
	Opt   *Options
	Redis *redis.Client
}

func NewRedisSync

func NewRedisSync(client *redis.Client, opts ...OptionFunc) *RedisSync

func (*RedisSync) NewMutex

func (s *RedisSync) NewMutex(key string, opts ...OptionFunc) Mutexer