officer 0.6.0 → 0.7.0

data/README.markdown

@@ -18,8 +18,8 @@ Here are some simple examples in case you aren't familiar with it.
 Officer's help information:
     sudo officer run -- --help
 
-Run Officer in the foreground with verbose mode enabled (useful for debugging):
-    sudo officer run -- -v
+Run Officer in the foreground with full logging and statistics:
+    sudo officer run -- -l debug -s
 
 Run Officer in the background (production mode) and listen on a specific IP and port:
     sudo officer start -- -h 127.0.0.1 -p 9999
@@ -33,41 +33,63 @@ Run Officer in the background (production mode) and listen on a specific IP and
     require 'rubygems'
     require 'officer'
 
-### Create a client object (defaults to localhost:11500)
+### Create a client object
 
     client = Officer::Client.new :host => 'localhost', :port => 11500
 
+Options:
+
+- :host => Hostname or IP address of the server to bind to (default: 0.0.0.0).
+- :port => TCP Port to listen on (default: 11500).
+
+
 ### Lock
 
     client.lock 'some_lock_name'
 
+Options:
+
+- :timeout => The number of seconds to wait for a lock to become available (default: wait forever).
+- :namespace => Prepend a namespace to each lock name (default: empty string).
+- :queue_max => If the lock queue length is greater than :queue_max then don't wait for the lock.
+
+
 ### Unlock
 
     client.unlock 'some_lock_name'
 
-### Wrap a block of code in a lock/unlock (with optional 5 second timeout)
+
+### Lock a block of code
 
     client.with_lock('some_lock_name', :timeout => 5) do
       puts 'hello world'
     end
 
+Options:
+
+- Same options as the above Lock command.
+
+
 ### Release all locks for this connection
 
     client.reset
 
+
 ### Reconnect (all locks will be released)
 
     client.reconnect
 
 - Useful if you use Officer with Phusion Passenger and smart spawning.  See [Passenger's documentation](http://www.modrails.com/documentation/Users%20guide%20Apache.html#_smart_spawning_gotcha_1_unintential_file_descriptor_sharing) for more information.
 
-### Locks
+
+### Show locks
 
     client.locks
 
 - Returns the internal state of all the server's locks.
 
-### Connections
+
+### Show connections
 
     client.connections
 
@@ -77,7 +99,6 @@ Run Officer in the background (production mode) and listen on a specific IP and
 
 - Retrieve the list of locks for the current connection.
 - Client: Option to abort a lock request if there is already a certain number of clients waiting for the lock.
-- Client: Namespaced lock names.
 - Server: configure the daemons gem to allow multiple server processes to run on one box.
 - Tests
 

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/bin/officer

@@ -38,7 +38,7 @@ def parse_command_line
     option :stats do
       short '-s'
       long '--stats'
-      desc 'Log stats every 5 seconds (default: off, requires log level: info)'
+      desc 'Log stats every 5 seconds (default: off, required log level: info)'
     end
 
     option :help do

data/lib/officer/client.rb

@@ -10,12 +10,14 @@ module Officer
   class AlreadyConnectedError < GenericError; end
   class LockError < GenericError; end
   class LockTimeoutError < LockError; end
+  class LockQueuedMaxError < LockError; end
   class UnlockError < GenericError; end
 
   class Client
     def initialize options={}
       @host = options[:host] || 'localhost'
       @port = options[:port] || 11500
+      @namespace = options[:namespace]
 
       connect
     end
@@ -26,11 +28,12 @@ module Officer
     end
 
     def lock name, options={}
-      execute :command => 'lock', :name => name, :timeout => options[:timeout]
+      execute :command => 'lock', :name => name_with_ns(name),
+        :timeout => options[:timeout], :queue_max => options[:queue_max]
     end
 
     def unlock name
-      execute :command => 'unlock', :name => name
+      execute :command => 'unlock', :name => name_with_ns(name)
     end
 
     def with_lock name, options={}
@@ -38,6 +41,7 @@ module Officer
       result = response['result']
       
       raise LockTimeoutError if result == 'timed_out'
+      raise LockQueuedMaxError if result == 'queue_maxed'
       raise LockError unless %w(acquired already_acquired).include?(result)
 
       begin
@@ -85,6 +89,10 @@ module Officer
       reconnect
       raise
     end
+
+    def name_with_ns name
+      @namespace ? "#{@namespace}:#{name}" : name
+    end
   end
 
 end

data/lib/officer/commands.rb

@@ -68,18 +68,21 @@ module Officer
       register
 
       def execute
-        Officer::LockStore.instance.acquire @name, @connection, :timeout => @timeout
+        Officer::LockStore.instance.acquire @name, @connection,
+          :timeout => @timeout, :queue_max => @queue_max
       end
 
     private
       def setup
         @name = @request['name']
         @timeout = @request['timeout']
+        @queue_max = @request['queue_max']
       end
 
       def valid?
         require_string @request['name']
         optional_positive_integer @request['timeout']
+        optional_positive_integer @request['queue_max']
       end
     end
 

data/lib/officer/connection.rb

@@ -77,6 +77,10 @@ module Officer
       def connections conns_hash
         send_result 'connections', :value => conns_hash
       end
+
+      def queue_maxed name
+        send_result 'queue_maxed', :name => name
+      end
     end
 
     class Connection < EventMachine::Protocols::LineAndTextProtocol

data/lib/officer/lock_store.rb

@@ -46,6 +46,15 @@ module Officer
     end
 
     def acquire name, connection, options={}
+      if options[:queue_max]
+        if @locks[name] && !@locks[name].queue.include?(connection)
+          if @locks[name].queue.length >= options[:queue_max]
+            connection.queue_maxed name
+            return
+          end
+        end
+      end
+
       @acquire_counter += 1
 
       lock = @locks[name] ||= Lock.new(name)

data/officer.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{officer}
-  s.version = "0.6.0"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chad Remesch"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: officer
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Chad Remesch