README

= revenant

* http://github.com/wilson/revenant

== DESCRIPTION:

Death is only a beginning. Failure will not be forgotten.

== FEATURES:

* Dead simple distributed locking
* Start as many masters as you want, only one will execute at a time
* Currently supports MySQL GET_LOCK()

== SYNOPSIS:

Have some work that needs to be done without worrying about mutual exclusion?
Lots of scheduled jobs to coordinate that must not interfere?
Want that work to keep happening when servers die?

#!/usr/bin/env ruby
require 'revenant'
task = revenant(:example)
task.on_load { require 'config/environment.rb' }
task.on_exit { something_to_do_last }
# start working and exit the parent process:
task.run { some_work_protected_by_mysql_lock }

Want to run without a distributed lock?
task.lock_function { true }
Want your code to sleep forever?
task.lock_function { false }

See the 'example' directory for more.

== REQUIREMENTS:

* mysql (not a dependency, but you will probably want it)

== INSTALL:

* gem install revenant

== LICENSE:

(The MIT License)

Copyright (c) 2010 Wilson Bilkovich

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.