Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrkamel/redlocker
Acquire and keep distributed locks using redis
https://github.com/mrkamel/redlocker
Last synced: 23 days ago
JSON representation
Acquire and keep distributed locks using redis
- Host: GitHub
- URL: https://github.com/mrkamel/redlocker
- Owner: mrkamel
- License: mit
- Created: 2021-10-28T16:07:40.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-03T15:56:10.000Z (almost 2 years ago)
- Last Synced: 2024-10-09T16:47:17.763Z (about 1 month ago)
- Language: Ruby
- Size: 29.3 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Redlocker
[](https://github.com/mrkamel/redlocker/actions?query=workflow%3Atest+branch%3Amaster)
[](http://badge.fury.io/rb/redlocker)
**Acquire and keep distributed locks alive using redis**
There are already quite some ruby libraries available which use redis for the
purpose of distributed locking, but they require you to specify the time
time-to-live of your locks. Contrary, Redlocker allows you to easily acquire
and keep distributed locks alive using redis. An acquired lock gets
automatically renewed every second from a thread, i.e. its 5 second expiry
value gets renewed in redis every second, and it gets released as soon as the
given block finishes.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'redlocker'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install redlocker
## Usage
Using Redlocker could not be easier:
```ruby
RedlockerClient = Redlocker::Client.new(redis: Redis.new)
RedlockerClient.with_lock('some_lock', timeout: 5) do
# lock acquired
end
```
If the lock can not be acquired within the specified `timeout`, a
`Redlocker::TimeoutError` is raised.
When the block finishes or raises, the acquired lock gets freed.
You can optionally pass a `delay` when acquiring a lock, which specifies the
time to wait between subsequent calls which check in redis whether or not the
lock is free. Default is 0.25 seconds:
```ruby
RedlockerClient.with_lock("some lock", timeout: 5, delay: 1) do
# lock acquired
end
```
If you are using a shared redis, you can pass a namespace, which will be used for
prefixing redis keys in addition to the default `redlocker:` namespace.
```ruby
RedlockerClient = Redlocker::Client.new(redis: Redis.new, namespace: "my-namespace")
```
That's it.
## Reference docs
Please find the reference docs at
[http://www.rubydoc.info/github/mrkamel/redlocker](http://www.rubydoc.info/github/mrkamel/redlocker)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run
`bundle exec rspec` to run the tests. You can also run `bin/console` for an
interactive prompt that will allow you to experiment.
## Contributing
Bug reports and pull requests are welcome on GitHub at
https://github.com/mrkamel/redlocker.
## License
The gem is available as open source under the terms of the [MIT
License](https://opensource.org/licenses/MIT).