redislock

Documentation

Overview

Package redislock implements locker based on Redis server

Index

• type Lock
  • func New(client redis.Cmdable, defaultLifetime time.Duration) *Lock
  • func NewByURL(connectURL string, defaultLifetime time.Duration) (*Lock, error)
  • func (mr *Lock) Expire(key interface{}, lifetime ...time.Duration) error
  • func (mr *Lock) IsLocked(key interface{}) bool
  • func (mr *Lock) TryLock(key interface{}, lifetime ...time.Duration) error
  • func (mr *Lock) Unlock(key interface{}) error

Types

type Lock

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

Lock provides redis key locker

func New

func New(client redis.Cmdable, defaultLifetime time.Duration) *Lock

New returns redis Lock for redis client

func NewByURL

func NewByURL(connectURL string, defaultLifetime time.Duration) (*Lock, error)

NewByURL returns redis Lock object or error Example "redis://host1:6379,host2:6379/12"

func (*Lock) Expire

func (mr *Lock) Expire(key interface{}, lifetime ...time.Duration) error

Expire TTL of existing lock

func (*Lock) IsLocked

func (mr *Lock) IsLocked(key interface{}) bool

IsLocked in the redis server

func (*Lock) TryLock

func (mr *Lock) TryLock(key interface{}, lifetime ...time.Duration) error

TryLock message as processing

func (*Lock) Unlock

func (mr *Lock) Unlock(key interface{}) error

Unlock message as processing