README
¶
Redsync
Redsync provides a Redis-based distributed mutual exclusion lock implementation for Go as described in this post. A reference library (by antirez) for Ruby is available at github.com/antirez/redlock-rb.
Installation
Install Redsync using the go get command:
$ go get gopkg.in/redsync.v1
The only dependencies are the Go distribution and Redigo.
NOTICE: Do NOT use versions after v2.0.0 and before v2.2.1
Documentation
Contributing
Contributions are welcome.
License
Redsync is available under the BSD (3-Clause) License.
Disclaimer
This code implements an algorithm which is currently a proposal, it was not formally analyzed. Make sure to understand how it works before using it in production environments.
Documentation
¶
Overview ¶
Package redsync provides a Redis-based distributed mutual exclusion lock implementation as described in the post http://redis.io/topics/distlock.
Values containing the types defined in this package should not be copied.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrTaken = errors.New(takenMsg)
ErrTaken happens when the lock is already taken in a quorum on nodes.
Functions ¶
This section is empty.
Types ¶
type Mutex ¶
type Mutex struct {
// contains filtered or unexported fields
}
A Mutex is a distributed mutual exclusion lock.
func (*Mutex) Extend ¶
Extend resets the mutex's expiry.
If not nil, the error will be either ErrTaken or a NoQuorum, which in turn contains NodeTaken or RedisError.
type NoQuorum ¶
type NoQuorum []error
NoQuorum is a series of errors, either NodeTaken or RedisError, that happened while trying to acquire or extend a lock in a cluster and prevent the lock to be taken in a quorum of nodes.
type NodeTaken ¶
type NodeTaken struct {
Node int
}
A NodeTaken happens when the lock is already taken in one of the cluster's nodes.
type Option ¶
type Option interface {
Apply(*Mutex)
}
An Option configures a mutex.
func SetDriftFactor ¶
SetDriftFactor can be used to set the clock drift factor.
func SetRetryDelay ¶
SetRetryDelay can be used to set the amount of time to wait between retries.
func SetRetryDelayFunc ¶
SetRetryDelayFunc can be used to override default delay behavior.
type RedisError ¶
A RedisError is an error communicating with one of the Redis nodes.
func (RedisError) Error ¶
func (err RedisError) Error() string
Source Files