sync

README

sync

distributed sync lock

Documentation

Index

• Variables
• type Mutexer
• type Option
  • func KeyPrefix(keyPrefix string) Option
  • func LockTimeout(lockTimeout time.Duration) Option
  • func WaitRetry(waitRetry time.Duration) Option
• type Options
• type RedisSync
  • func NewRedisSync(redis *redis.Client, opts ...Option) *RedisSync
  • func (r *RedisSync) NewMutex(key string, opts ...Option) Mutexer

Variables

var (
	// ErrLockFailed 加锁失败
	ErrLockFailed = errors.New("lock failed")
	// ErrUnlockFailed 解锁失败
	ErrUnlockFailed = errors.New("unlock failed")
)

Types

type Mutexer

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

Mutexer 互斥锁

type Option

type Option func(*Options)

Option 为可选参数赋值的函数

func KeyPrefix

func KeyPrefix(keyPrefix string) Option

KeyPrefix ...

func LockTimeout

func LockTimeout(lockTimeout time.Duration) Option

LockTimeout ...

func WaitRetry

func WaitRetry(waitRetry time.Duration) Option

WaitRetry ...

type Options

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

Options ...

type RedisSync

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

RedisSync ...

func NewRedisSync

func NewRedisSync(redis *redis.Client, opts ...Option) *RedisSync

NewRedisSync ...

func (*RedisSync) NewMutex

func (r *RedisSync) NewMutex(key string, opts ...Option) Mutexer

NewMutex 创建互斥锁