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

on second thought, remove confusing language

Browse Source
This commit is contained in:
Nick Elser
2015-04-13 22:20:44 -07:00
parent aaee69a2df
commit 308e918e60
2 changed files with 3 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -1,8 +1,8 @@
# Suo [![Build Status](https://travis-ci.org/nickelser/suo.svg?branch=master)](https://travis-ci.org/nickelser/suo) [![Code Climate](https://codeclimate.com/github/nickelser/suo/badges/gpa.svg)](https://codeclimate.com/github/nickelser/suo) [![Test Coverage](https://codeclimate.com/github/nickelser/suo/badges/coverage.svg)](https://codeclimate.com/github/nickelser/suo) [![Gem Version](https://badge.fury.io/rb/suo.svg)](http://badge.fury.io/rb/suo) # Suo [![Build Status](https://travis-ci.org/nickelser/suo.svg?branch=master)](https://travis-ci.org/nickelser/suo) [![Code Climate](https://codeclimate.com/github/nickelser/suo/badges/gpa.svg)](https://codeclimate.com/github/nickelser/suo) [![Test Coverage](https://codeclimate.com/github/nickelser/suo/badges/coverage.svg)](https://codeclimate.com/github/nickelser/suo) [![Gem Version](https://badge.fury.io/rb/suo.svg)](http://badge.fury.io/rb/suo)
:lock: Distributed locks using Memcached or Redis in Ruby. :lock: Distributed semaphores using Memcached or Redis in Ruby.
Suo provides a very performant distributed lock solution using Compare-And-Set (`CAS`) commands in Memcached, and `WATCH/MULTI` in Redis. It allows locking both single exclusion (a mutex - sharing one resource), and multiple resources. Suo provides a very performant distributed lock solution using Compare-And-Set (`CAS`) commands in Memcached, and `WATCH/MULTI` in Redis. It allows locking both single exclusion (like a mutex - sharing one resource), as well as multiple resources.
## Installation ## Installation
@@ -70,10 +70,6 @@ suo.lock("foo") do |lock|
end end
``` ```
## Semaphore
With multiple resources, Suo acts like a semaphore, but is not strictly a semaphore according to the traditional definition, as the lock acquires ownership.
## TODO ## TODO
- more race condition tests - more race condition tests

2
suo.gemspec
View File

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
spec.email = ["nick.elser@gmail.com"] spec.email = ["nick.elser@gmail.com"]
spec.summary = %q(Distributed locks using Memcached or Redis.) spec.summary = %q(Distributed locks using Memcached or Redis.)
spec.description = %q(Distributed locks using Memcached or Redis.) spec.description = %q(Distributed locks (mutexes & semaphores) using Memcached or Redis.)
spec.homepage = "https://github.com/nickelser/suo" spec.homepage = "https://github.com/nickelser/suo"
spec.license = "MIT" spec.license = "MIT"