README
¶
disLock redis分布式锁
实现了一个基于redigo的分布式锁（distribute lock）支持自动续期
使用方式：
import(
"github.com/danliznh/dislock"
)
查看examples.go
支持红锁redlock
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrNotObtained is returned when a lock cannot be obtained. ErrNotObtained = errors.New("dislock: not obtained") // ErrLockNotHeld is returned when trying to release an inactive lock. ErrLockNotHeld = errors.New("dislock: lock not held") )
Functions ¶
This section is empty.
Types ¶
type DisLockClient ¶
type DisLockClient struct {
// contains filtered or unexported fields
}
func New ¶
func New(conn redis.Conn) *DisLockClient
func (*DisLockClient) Obtain ¶
func (c *DisLockClient) Obtain(ctx context.Context, key string, ttl time.Duration, opt *Options) (*Lock, error)
Obtain tries to obtain a new lock using a unit_key with the given TTL. May return ErrNotObtained if not successful.
type Lock ¶
type Lock struct {
// contains filtered or unexported fields
}
Lock represents an obtained, distributed lock.
func Obtain ¶
func Obtain(ctx context.Context, conn redis.Conn, key string, ttl time.Duration, opt *Options) (*Lock, error)
Obtain is a short-cut for New(...).Obtain(...).
func (*Lock) Refresh ¶
Refresh extends the lock with a new TTL. May return ErrNotObtained if refresh is unsuccessful.
type Options ¶
type Options struct {
// RetryStrategy allows to customise the lock retry strategy.
// Default: do not retry
RetryStrategy RetryStrategy
// Metadata string is appended to the lock token.
Metadata string
}
Options describe the options for the lock
type RedLock ¶
type RedLock struct {
// contains filtered or unexported fields
}
type RedSync ¶
type RedSync struct {
// contains filtered or unexported fields
}
func NewRedSync ¶
func (*RedSync) NewRedLock ¶
type RetryStrategy ¶
type RetryStrategy interface {
// NextBackoff returns the next backoff duration.
NextBackoff() time.Duration
}
RetryStrategy allows to customise the lock retry strategy.
func ExponentialBackoff ¶
func ExponentialBackoff(min, max time.Duration) RetryStrategy
ExponentialBackoff strategy is an optimization strategy with a retry time of 2**n milliseconds (n means number of times). You can set a minimum and maximum value, the recommended minimum value is not less than 16ms.
func LimitRetry ¶
func LimitRetry(s RetryStrategy, max int) RetryStrategy
LimitRetry limits the number of retries to max attempts.
func LinearBackoff ¶
func LinearBackoff(backoff time.Duration) RetryStrategy
LinearBackoff allows retries regularly with customized intervals
Source Files