https://github.com/da440dil/go-locker
Distributed locking on Go
https://github.com/da440dil/go-locker
distributed distributed-lock distributed-locking go golang lock locking locks redis
Last synced: 25 days ago
JSON representation
Distributed locking on Go
- Host: GitHub
- URL: https://github.com/da440dil/go-locker
- Owner: da440dil
- License: mit
- Created: 2019-03-08T10:19:04.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-11-09T06:35:00.000Z (over 4 years ago)
- Last Synced: 2025-05-18T14:48:18.475Z (11 months ago)
- Topics: distributed, distributed-lock, distributed-locking, go, golang, lock, locking, locks, redis
- Language: Go
- Homepage:
- Size: 85 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-locker
[](https://travis-ci.com/da440dil/go-locker)
[](https://coveralls.io/github/da440dil/go-locker?branch=master)
[](https://pkg.go.dev/github.com/da440dil/go-locker)
[](https://goreportcard.com/report/github.com/da440dil/go-locker)
Distributed locking using [Redis](https://redis.io/).
[Example](./examples/main.go) usage:
```go
import (
"context"
"fmt"
"sync"
"time"
"github.com/da440dil/go-locker"
"github.com/go-redis/redis/v8"
)
func main() {
client := redis.NewClient(&redis.Options{})
defer client.Close()
// Create locker.
lkr := locker.NewLocker(client)
ctx := context.Background()
key := "key"
err := client.Del(ctx, key).Err()
requireNoError(err)
lock := func() {
// Try to apply lock.
lr, err := lkr.Lock(ctx, key, time.Second)
requireNoError(err)
if !lr.OK() {
fmt.Printf("Failed to apply lock, retry after %v\n", lr.TTL())
return
}
fmt.Println("Lock applied")
// Try to release lock.
defer func() {
ok, err := lr.Unlock(ctx)
requireNoError(err)
if ok {
fmt.Println("Lock released")
} else {
fmt.Println("Failed to release lock")
}
}()
time.Sleep(time.Millisecond * 100) // some code here
// Optionally try to extend lock.
r, err := lr.Lock.Lock(ctx, time.Second)
requireNoError(err)
if !r.OK() {
fmt.Printf("Failed to extend lock, retry after %v\n", lr.TTL())
return
}
fmt.Println("Lock extended")
}
var wg sync.WaitGroup
wg.Add(2)
for i := 0; i < 2; i++ {
go func() {
defer wg.Done()
lock()
}()
}
wg.Wait()
// Output:
// Lock applied
// Failed to apply lock, retry after 999ms
// Lock extended
// Lock released
}
func requireNoError(err error) {
if err != nil {
panic(err)
}
}
```