dkam/suo
1
0
Fork 0
mirror of https://github.com/dkam/suo.git synced 2025-01-29 07:42:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

edits to docs

Browse Source
This commit is contained in:
Ian Remillard
2018-09-28 16:43:44 -07:00
parent aa4da5d739
commit 6be3a5bdda
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -78,7 +78,7 @@ end
Suo::Client::Redis.new("bar_resource", ttl: 10) #ttl in seconds Suo::Client::Redis.new("bar_resource", ttl: 10) #ttl in seconds
``` ```
All locks are expired and the lock key is removed after the specified `ttl` time runs out. This would be the time since any resource for a given key was locked or unlocked. All locks are expired and the lock key is removed after the specified `ttl` time runs out. This is counted as the time since any resource for a given key was locked or unlocked.
### Lock Release Removes Key ### Lock Release Removes Key
@@ -86,7 +86,7 @@ All locks are expired and the lock key is removed after the specified `ttl` time
Suo::Client::Redis.new("bar_resource", lock_release_removes_key: true) Suo::Client::Redis.new("bar_resource", lock_release_removes_key: true)
``` ```
Normally, a key representing a set of resource locks is persisted indefinitely even when no resources are currently locked. When `lock_release_removes_key` is set to `true`, the key is removed when the last resource lock is released. This also means that when another lock is acquired the key has to be recreated. By default, a key representing a set of resource locks is persisted indefinitely even when no resources are currently locked. When `lock_release_removes_key` is set to `true`, the key is removed when the last resource lock is released. This also means that when another lock is acquired the key has to be recreated.
## TODO ## TODO
- more race condition tests - more race condition tests