mirror of
https://github.com/hanzokv/lock.git
synced 2026-10-30 15:07:01 +00:00
github.com/hanzokv/go/v9 v9.22.0 renamed its Go package from "redis" to "kv"; the import path is unchanged. A lock library is typed against the client it wraps -- the adapter's NewPool takes the client's UniversalClient and compares against the client's Nil sentinel -- so the qualifier change is load bearing, not cosmetic. Client-driven: - go.mod: github.com/hanzokv/go/v9 v9.21.1 -> v9.22.0 - the adapter for our client speaks kv.UniversalClient / kv.Nil, imported unaliased as in hanzokv/go's own sources Our own vocabulary follows: - redis/ -> kv/, package redis -> package kv. This is redsync's own Pool/Conn/Script abstraction over a KV backend, not anyone's product. - redis/goredis/v9 -> kv/kvgo (package kvgo). That adapter wraps hanzokv/go, not go-redis; the old name said the wrong thing. Its example moves with it: examples/goredis/v9 -> examples/kvgo. - import alias redsyncredis -> redsynckv - RedisError -> KVError (and its tests) - comments and README speak kv Deliberately NOT renamed, because they name foreign things: - the redigo, rueidis, valkeygo and go-redis v6/v7/v8 adapters, which target genuinely different clients, keep their names and their own "redis." qualifiers (redigo's redis.Conn, go-redis's redis.Nil) - the server-side Lua in scripts.go: redis.call is the store's scripting API. Rewriting it would change the script source and therefore the SHA1 hashes pinned in scripts.go, which TestScripts_Hash verifies against a live server. - upstream links (redis.io distlock post, redigo attribution) Import paths move from .../v4/redis/... to .../v4/kv/...; the module major stays v4 by policy. Verified with a local redis-server: go build ./..., go vet ./..., go test -count=1 ./... and go test -race -count=1 ./... all pass, TestScripts_Hash included. Co-authored-by: Hanzo Dev <[email protected]>
51 lines
1.3 KiB
Go
51 lines
1.3 KiB
Go
package redsync
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
)
|
|
|
|
// ErrFailed is the error resulting if Redsync fails to acquire the lock after
|
|
// exhausting all retries.
|
|
var ErrFailed = errors.New("redsync: failed to acquire lock")
|
|
|
|
// ErrExtendFailed is the error resulting if Redsync fails to extend the
|
|
// lock.
|
|
var ErrExtendFailed = errors.New("redsync: failed to extend lock")
|
|
|
|
// ErrLockAlreadyExpired is the error resulting if trying to unlock the lock which already expired.
|
|
var ErrLockAlreadyExpired = errors.New("redsync: failed to unlock, lock was already expired")
|
|
|
|
// ErrTaken happens when the lock is already taken in a quorum on nodes.
|
|
type ErrTaken struct {
|
|
Nodes []int
|
|
}
|
|
|
|
func (err ErrTaken) Error() string {
|
|
return fmt.Sprintf("lock already taken, locked nodes: %v", err.Nodes)
|
|
}
|
|
|
|
// ErrNodeTaken is the error resulting if the lock is already taken in one of
|
|
// the cluster's nodes
|
|
type ErrNodeTaken struct {
|
|
Node int
|
|
}
|
|
|
|
func (err ErrNodeTaken) Error() string {
|
|
return fmt.Sprintf("node #%d: lock already taken", err.Node)
|
|
}
|
|
|
|
// A KVError is an error communicating with one of the KV nodes.
|
|
type KVError struct {
|
|
Node int
|
|
Err error
|
|
}
|
|
|
|
func (e KVError) Error() string {
|
|
return fmt.Sprintf("node #%d: %s", e.Node, e.Err)
|
|
}
|
|
|
|
func (e KVError) Unwrap() error {
|
|
return e.Err
|
|
}
|