officer 0.1.1 → 0.2.1

data/README.markdown

@@ -0,0 +1,50 @@
+# Officer - Distributed Lock Server and Client
+
+This project is a work in progress and shouldn't be considered production ready at this time.
+It is implemented using Ruby and Eventmachine. Inspiration comes from [elock](http://github.com/dustin/elock).
+
+## Installation
+
+	install gemcutter
+	gem install officer
+
+## Usage
+
+Start the server using the 'officer' command in a shell.
+It will listen on all interfaces on port 11500.
+All debugging output goes to stdout for now.
+
+## Ruby Client
+
+	require 'rubygems'
+	require 'officer'
+
+### Create a client object (:host and :port default to localhost:11500)
+
+	client = Officer::Client.new :host => 'localhost', :port => 11500
+
+### Lock
+
+	client.lock 'some_lock_name'
+
+### Unlock
+
+	client.unlock 'some_lock_name
+
+### Wrap a block of code in a lock/unlock (with optional 5 second timeout)
+
+	client.with_lock('some_lock_name', :timeout => 5) do
+	  puts 'hello world'
+	end
+
+### Release all locks for this connection
+
+	client.reset
+
+### Reconnect (all locks will be released)
+
+	client.reconnect
+
+## Copyright
+
+Copyright (c) 2010 Chad Remesch. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.1

data/lib/officer/client.rb

@@ -11,6 +11,7 @@ module Officer
   class AlreadyConnectedError < GenericError; end
   class NotConnectedError < GenericError; end
   class LockError < GenericError; end
+  class LockTimeoutError < LockError; end
   class UnlockError < GenericError; end
 
   class Client
@@ -28,17 +29,20 @@ module Officer
       connect
     end
 
-    def lock name
-      execute({:command => 'lock', :name => name}.to_json)
+    def lock name, options={}
+      execute({:command => 'lock', :name => name, :timeout => options[:timeout]}.to_json)
     end
 
     def unlock name
       execute({:command => 'unlock', :name => name}.to_json)
     end
 
-    def with_lock name
-      response = lock name
-      raise LockError unless response['result'] == 'acquired'
+    def with_lock name, options={}
+      response = lock name, options
+      result = response['result']
+      
+      raise LockTimeoutError if result == 'timed_out'
+      raise LockError if result != 'acquired'
 
       begin
         yield
@@ -48,6 +52,10 @@ module Officer
       end
     end
 
+    def reset
+      execute({:command => 'reset'}.to_json)
+    end
+
   private
     def connect
       raise AlreadyConnectedError if @socket

data/lib/officer/commands.rb

@@ -37,13 +37,20 @@ module Officer
       end
 
     private
-      def valid?
-        raise 'Must override.'
+      def setup # Override if necessary.
+      end
+
+      def valid? # Override if necessary.
+        true
       end
 
       def require_string arg
         arg.class == String && arg.length > 0
       end
+
+      def optional_positive_integer arg
+        arg.nil? || (arg.is_a?(Fixnum) && arg > 0)
+      end
     end
 
     class Lock < Base
@@ -51,16 +58,18 @@ module Officer
 
       def execute
         L.debug 'executing lock command.'
-        Officer::LockStore.instance.acquire @name, @connection
+        Officer::LockStore.instance.acquire @name, @connection, :timeout => @timeout
       end
 
     private
       def setup
         @name = @request['name']
+        @timeout = @request['timeout']
       end
 
       def valid?
         require_string @request['name']
+        optional_positive_integer @request['timeout']
       end
     end
 
@@ -81,5 +90,14 @@ module Officer
         require_string @request['name']
       end
     end
+
+    class Reset < Base
+      register
+
+      def execute
+        L.debug 'executing reset command.'
+        Officer::LockStore.instance.reset @connection
+      end
+    end
   end
 end

data/lib/officer/connection.rb

@@ -4,7 +4,9 @@ module Officer
     module EmCallbacks
       def post_init
         L.debug "Client connected."
+
         @connected = true
+        @timers = {} # name => Timer
       end
 
       def receive_line line
@@ -24,31 +26,64 @@ module Officer
         @connected = false
 
         L.debug "client disconnected."
-        Officer::LockStore.instance.unbind self
+
+        Officer::LockStore.instance.reset self
       end
     end
 
     module LockCallbacks
       def acquired name
         L.debug "acquired lock: #{name}"
+
+        @timers.delete(name).cancel if @timers[name]
+
         send_line({:result => 'acquired', :name => name}.to_json)
       end
 
       def released name
         L.debug "released lock: #{name}"
+
         send_line({:result => 'released', :name => name}.to_json)
       end
 
       def release_failed name
         L.debug "release lock failed: #{name}"
+
         send_line({:result => 'release_failed', :name => name}.to_json)
       end
+
+      def reset_succeeded
+        L.debug "reset"
+        
+        @timers.values.each {|timer| timer.cancel}
+        send_line({:result => 'reset_succeeded'}.to_json)
+      end
+
+      def queued name, options={}
+        L.debug "queued. options=#{options.inspect}"
+
+        timeout = options[:timeout]
+
+        return if timeout.nil? || @timers[name]
+
+        @timers[name] = EM::Timer.new(timeout) do
+          Officer::LockStore.instance.timeout name, self
+        end
+      end
+
+      def timed_out name
+        L.debug "Timed out connection=#{object_id}, name=#{name}"
+
+        @timers.delete name
+        send_line({:result => 'timed_out', :name => name}.to_json)
+      end
     end
 
     class Connection < EventMachine::Protocols::LineAndTextProtocol
       include EmCallbacks
       include LockCallbacks
 
+    private
       attr_reader :connected
 
       def send_line line

data/lib/officer/lock_store.rb

@@ -15,7 +15,7 @@ module Officer
 
     def initialize
       @locks = {} # name => Lock
-      @connections = {} # Connection => [name, ...]
+      @connections = {} # Connection => Set(name, ...)
     end
 
     def log_state
@@ -32,43 +32,45 @@ module Officer
 
       puts "Connections:"
       @connections.each do |connection, names|
-        puts "#{connection.object_id}: names=[#{names.join(', ')}]"
+        puts "#{connection.object_id}: names=[#{names.to_a.join(', ')}]"
       end
       puts
 
       L.debug '-----'
     end
 
-    def acquire name, connection
+    def acquire name, connection, options={}
       lock = @locks[name] ||= Lock.new(name)
 
-      # Queue the lock request unless this connection already has the lock.
-      unless lock.queue.include? connection
-        lock.queue << connection
-        (@connections[connection] ||= []) << name
-      end
+      lock.queue << connection unless lock.queue.include? connection
+
+      (@connections[connection] ||= Set.new) << name
       
-      # Tell the client to block unless it has acquired the lock.
       if lock.queue.first == connection
         connection.acquired name
+      else
+        connection.queued name, options
       end
     end
 
-    def release name, connection
+    def release name, connection, options={}
+      options.reverse_merge! :callback => true
+
       lock = @locks[name]
       names = @connections[connection]
 
       # Client should only be able to release a lock that
       # exists and that it has previously queued.
       if lock.nil? || !names.include?(name)
-        connection.release_failed(name) and return
+        connection.release_failed(name) if options[:callback]
+        return
       end
 
       # If connecton has the lock, release it and let the next
       # connection know that it has acquired the lock.
       if lock.queue.first == connection
         lock.queue.shift
-        connection.released name
+        connection.released name if options[:callback]
 
         if next_connection = lock.queue.first
           next_connection.acquired name
@@ -76,24 +78,35 @@ module Officer
           @locks.delete name
         end
 
-      # If the connection is queued, but doesn't have the lock,
-      # release it and leave the other connections alone.
+      # If the connection is queued and doesn't have the lock,
+      # dequeue it and leave the other connections alone.
       else
         lock.queue.delete connection
         connection.released name
       end
 
-      @connections[connection].delete name
+      names.delete name
     end
 
-    def unbind connection
-      names = @connections[connection] || []
+    def reset connection
+      names = @connections[connection] || Set.new
 
       names.each do |name|
-        release name, connection
+        release name, connection, :callback => false
       end
 
       @connections.delete connection
+      connection.reset_succeeded
+    end
+
+    def timeout name, connection
+      lock = @locks[name]
+      names = @connections[connection]
+
+      lock.queue.delete connection
+      names.delete name
+
+      connection.timed_out name
     end
   end
 

data/officer.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{officer}
-  s.version = "0.1.1"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chad Remesch"]
@@ -16,13 +16,13 @@ Gem::Specification.new do |s|
   s.executables = ["officer"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.markdown"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.markdown",
      "Rakefile",
      "VERSION",
      "bin/officer",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: officer
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Chad Remesch
@@ -50,12 +50,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - bin/officer

data/README.rdoc

@@ -1,8 +0,0 @@
-= Officer - Distributed Lock Server and Client
-
-This project is a work in progress and shouldn't be considered production ready at this time.
-It is implemented using Ruby and Eventmachine. Inspiration comes from elock.
-
-== Copyright
-
-Copyright (c) 2010 Chad Remesch. See LICENSE for details.