locker

Documentation

Index

• type Config
• type Locker
  • func CreateNew(config *Config) (*Locker, error)
  • func (l *Locker) LockForKey(key string, expiry time.Duration) (*redsync.Mutex, error)
  • func (l *Locker) LockForKeyWithNoRetry(key string, expiry time.Duration) (*redsync.Mutex, error)
  • func (l *Locker) LockForKeyWithRetry(key string, expiry time.Duration, retry int) (*redsync.Mutex, error)
  • func (l *Locker) LockForKeyWithRetryDelay(key string, expiry time.Duration, retry int, retryDelay time.Duration) (*redsync.Mutex, error)
  • func (l *Locker) Unlock(key string) (bool, error)

Types

type Config

type Config struct {
	// RedisAddress address for redis
	RedisAddress []string `yaml:"redis-address" json:"redisAddress,omitempty"`
}

Config for redis config locker

type Locker

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

Locker gloable locker

func CreateNew

func CreateNew(config *Config) (*Locker, error)

CreateNew new instance

func (*Locker) LockForKey

func (l *Locker) LockForKey(key string, expiry time.Duration) (*redsync.Mutex, error)

LockForKey lock for special key

func (*Locker) LockForKeyWithNoRetry

func (l *Locker) LockForKeyWithNoRetry(key string, expiry time.Duration) (*redsync.Mutex, error)

LockForKeyWithNoRetry lock for special key

func (*Locker) LockForKeyWithRetry

func (l *Locker) LockForKeyWithRetry(key string, expiry time.Duration, retry int) (*redsync.Mutex, error)

LockForKeyWithRetry lock for special key

func (*Locker) LockForKeyWithRetryDelay

func (l *Locker) LockForKeyWithRetryDelay(key string, expiry time.Duration, retry int, retryDelay time.Duration) (*redsync.Mutex, error)

LockForKeyWithRetryDelay lock for special key

func (*Locker) Unlock

func (l *Locker) Unlock(key string) (bool, error)

Unlock unlock a key