daemon_controller 0.2.6 → 1.0.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Phusion
+Copyright (c) 2008, 2009, 2010, 2011, 2012 Phusion
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.markdown

@@ -31,10 +31,9 @@ It provides the following functionality:
 
 ## Resources
 
-*   [Website](http://github.com/FooBarWidget/daemon_controller)
+*   [Website](https://github.com/FooBarWidget/daemon_controller)
 *   [RDoc](http://rdoc.info/projects/FooBarWidget/daemon_controller)
 *   [Git repository](git://github.com/FooBarWidget/daemon_controller.git)
-*   [RubyForge project](http://rubyforge.org/projects/daemoncontrol/)
 
 
 What is it for?
@@ -317,7 +316,7 @@ That can be done with the following code:
     controller = DaemonController.new(
        :identifier    => 'Apache web server',
        :start_command => 'apachectl -f apache.conf -k start',
-       :ping_command  => lambda { TCPSocket.new('localhost', 1234) },
+       :ping_command  => [:tcp, 'localhost', 1234],
        :pid_file      => 'apache.pid',
        :log_file      => 'apache.log',
        :start_timeout => 25
@@ -401,7 +400,7 @@ This can be achieved with the following code:
              :identifier => 'Sphinx search server',
              :start_command => "searchd -c config/sphinx.conf",
              :before_start => method(:before_start),
-             :ping_command => lambda { TCPSocket.new('localhost', SEARCH_SERVER_PORT) },
+             :ping_command => [:tcp, 'localhost', SEARCH_SERVER_PORT],
              :pid_file => 'tmp/pids/sphinx.pid',
              :log_file => 'log/sphinx.log')
        end
@@ -458,11 +457,40 @@ when the daemon is designed from the beginning with such abilities in mind, but
 it's compatible with virtually all daemons, and is easy to use.
 
 
-Concurrency notes
-=================
-DaemonController can only guarantee concurrency safety between multiple threads
-in the same process, if all of those threads use the same DaemonController
-object. Synchronization between multiple processes works fine.
+Concurrency and compatibility notes
+===================================
+DaemonController uses a lock file and the Ruby `File#flock` API to guarantee
+synchronization. This has a few implications:
+
+ * On most Ruby implementations, including MRI, `File#flock` is implemented
+   with the POSIX `flock()` system call or the Windows file locking APIs.
+   This kind of file locking works pretty much the way we expect it would.
+   Multiple threads can safely use daemon_controller concurrently. Multiple
+   processes can safely use daemon_controller concurrently. There will be no
+   race conditions.
+   
+   However `flock()` is not implemented on Solaris. daemon_controller, if
+   used in MRI does not currently work on Solaris. You need to use JRuby
+   which does not use `flock()` to implement `File#flock`.
+   
+ * On JRuby `File#flock` is implemented through the Java file locking API,
+   which on Unix is implemented with the `fcntl()` system calls. This is a
+   different kind of lock with very strange semantics.
+
+   * If *any* process/thread closes the lock file, then the lock on that file
+     will be removed even if that process/thread never requested a lock.
+   * Fcntl locks are usually implemented indepedently from `flock()` locks so
+     if a file is already locked with `flock()` then `fcntl()` will not block
+     when.
+   * The JVM's file locking API only allows inter-process synchronization. It
+     cannot be used to synchronize threads. If a thread has obtained a file
+     lock, then another thread within the same JVM process will not block upon
+     trying to lock the same file.
+   
+   In other words, if you're on JRuby then don't concurrently access
+   daemon_controller from multiple threads without manual locking. Also be
+   careful with mixing MRI processes that use daemon_controller with JRuby
+   processes that use daemon_controller.
 
 
 API documentation

data/daemon_controller.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
   s.name = "daemon_controller"
   # Don't forget to update version.rb too.
-  s.version = "0.2.6"
-  s.date = "2011-02-13"
+  s.version = "1.0.0"
+  s.date = "2012-02-04"
   s.summary = "A library for implementing daemon management capabilities"
   s.email = "hongli@phusion.nl"
-  s.homepage = "http://github.com/FooBarWidget/daemon_controller/tree/master"
+  s.homepage = "https://github.com/FooBarWidget/daemon_controller"
   s.description = "A library for robust daemon management."
   s.has_rdoc = true
   s.authors = ["Hongli Lai"]

data/lib/daemon_controller/spawn.rb

@@ -19,6 +19,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-# Used on Ruby 1.9 because forking is not safe.
+# Used on Ruby 1.9 because forking may not be safe/supported on all platforms.
 Process.setsid
 Process.spawn(ARGV[0])

data/lib/daemon_controller/version.rb

@@ -1,5 +1,5 @@
 # daemon_controller, library for robust daemon management
-# Copyright (c) 2010 Phusion
+# Copyright (c) 2010, 2011, 2012 Phusion
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -20,8 +20,8 @@
 # THE SOFTWARE.
 
 class DaemonController
-	MAJOR = 0
-	MINOR = 2
-	TINY  = 6
+	MAJOR = 1
+	MINOR = 0
+	TINY  = 0
 	VERSION_STRING = "#{MAJOR}.#{MINOR}.#{TINY}"
 end # class DaemonController

data/lib/daemon_controller.rb

@@ -1,5 +1,5 @@
 # daemon_controller, library for robust daemon management
-# Copyright (c) 2010 Phusion
+# Copyright (c) 2010, 2011, 2012 Phusion
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -85,14 +85,19 @@ class DaemonController
 	#  The value may be a command string. This command must exit with an exit code of
 	#  0 if the daemon can be successfully connected to, or exit with a non-0 exit
 	#  code on failure.
+	#
+	#  The value may also be an Array which specifies the socket address of the daemon.
+	#  It must be in one of the following forms:
+	#  - [:tcp, host_name, port]
+	#  - [:unix, filename]
 	#  
 	#  The value may also be a Proc, which returns an expression that evaluates to
 	#  true (indicating that the daemon can be connected to) or false (failure).
 	#  If the Proc raises Errno::ECONNREFUSED, Errno::ENETUNREACH, Errno::ETIMEDOUT
-	#  or Errno::ECONNRESET, Errno::EINVAL and Errno::EADDRNOTAVAIL then that also
+	#  Errno::ECONNRESET, Errno::EINVAL or Errno::EADDRNOTAVAIL then that also
 	#  means that the daemon cannot be connected to.
 	#  <b>NOTE:</b> if the ping command returns an object which responds to
-	#  <tt>#close</tt>, then that method will be called on the return value.
+	#  <tt>#close</tt>, then that method will be called on it.
 	#  This makes it possible to specify a ping command such as
 	#  <tt>lambda { TCPSocket.new('localhost', 1234) }</tt>, without having to worry
 	#  about closing it afterwards.
@@ -101,6 +106,10 @@ class DaemonController
 	# [:pid_file]
 	#  The PID file that the daemon will write to. Used to check whether the daemon
 	#  is running.
+	#
+	# [:lock_file]
+	#  The lock file to use for serializing concurrent daemon management operations.
+	#  Defaults to "(filename of PID file).lock".
 	#  
 	# [:log_file]
 	#  The log file that the daemon will write to. It will be consulted to see
@@ -183,7 +192,7 @@ class DaemonController
 		@log_file_activity_timeout = options[:log_file_activity_timeout] || 7
 		@daemonize_for_me = options[:daemonize_for_me]
 		@keep_ios = options[:keep_ios] || []
-		@lock_file = determine_lock_file(@identifier, @pid_file)
+		@lock_file = determine_lock_file(options, @identifier, @pid_file)
 	end
 	
 	# Start the daemon and wait until it can be pinged.
@@ -538,8 +547,12 @@ private
 		return nil
 	end
 	
-	def determine_lock_file(identifier, pid_file)
-		return LockFile.new(File.expand_path(pid_file + ".lock"))
+	def determine_lock_file(options, identifier, pid_file)
+		if options[:lock_file]
+			return LockFile.new(File.expand_path(options[:lock_file]))
+		else
+			return LockFile.new(File.expand_path(pid_file + ".lock"))
+		end
 	end
 	
 	def self.fork_supported?
@@ -650,11 +663,46 @@ private
 			rescue *ALLOWED_CONNECT_EXCEPTIONS
 				return false
 			end
+		elsif @ping_command.is_a?(Array)
+			type, *args = @ping_command
+			
+			case type
+			when :tcp
+				socket_domain = Socket::Constants::AF_INET
+				hostname, port = args
+				sockaddr = Socket.pack_sockaddr_in(port, hostname)
+			when :unix
+				socket_domain = Socket::Constants::AF_LOCAL
+				sockaddr = Socket.pack_sockaddr_un(args[0])
+			else
+				raise ArgumentError, "Unknown ping command type #{type.inspect}"
+			end
+
+			begin
+				socket = Socket.new(socket_domain, Socket::Constants::SOCK_STREAM, 0)
+				begin
+					socket.connect_nonblock(sockaddr)
+				rescue Errno::ENOENT, Errno::EINPROGRESS, Errno::EAGAIN, Errno::EWOULDBLOCK
+					if select(nil, [socket], nil, 0.1)
+						begin
+							socket.connect_nonblock(sockaddr)
+						rescue Errno::EISCONN
+						end
+					else
+						raise Errno::ECONNREFUSED
+					end
+				end
+				return true
+			rescue Errno::ECONNREFUSED, Errno::ENOENT
+				return false
+			ensure
+				socket.close if socket
+			end
 		else
 			return system(@ping_command)
 		end
 	end
-	
+
 	def safe_fork(double_fork)
 		pid = fork
 		if pid.nil?
@@ -674,8 +722,9 @@ private
 					"\tfrom " << e.backtrace.join("\n\tfrom ")
 				STDERR.write(e)
 				STDERR.flush
-			ensure
 				exit!
+			ensure
+				exit!(0)
 			end
 		else
 			if double_fork

data/spec/daemon_controller_spec.rb

@@ -361,4 +361,28 @@ describe DaemonController do
 			server.close
 		end
 	end
+
+	specify "the ping command may be [:tcp, hostname, port]" do
+		new_controller(:ping_command => [:tcp, "localhost", 8278])
+		@controller.send(:run_ping_command).should be_false
+
+		server = TCPServer.new('localhost', 8278)
+		begin
+			@controller.send(:run_ping_command).should be_true
+		ensure
+			server.close
+		end
+	end
+
+	specify "the ping command may be [:unix, filename]" do
+		new_controller(:ping_command => [:unix, "spec/foo.sock"])
+		@controller.send(:run_ping_command).should be_false
+
+		server = UNIXServer.new('spec/foo.sock')
+		begin
+			@controller.send(:run_ping_command).should be_true
+		ensure
+			server.close
+		end
+	end
 end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: daemon_controller
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
-  version: 0.2.6
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Hongli Lai
@@ -10,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-13 00:00:00 +01:00
-default_executable: 
+date: 2012-02-04 00:00:00 Z
 dependencies: []
 
 description: A library for robust daemon management.
@@ -34,8 +38,7 @@ files:
 - spec/daemon_controller_spec.rb
 - spec/echo_server.rb
 - spec/unresponsive_daemon.rb
-has_rdoc: true
-homepage: http://github.com/FooBarWidget/daemon_controller/tree/master
+homepage: https://github.com/FooBarWidget/daemon_controller
 licenses: []
 
 post_install_message: 
@@ -48,19 +51,26 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.1
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A library for implementing daemon management capabilities
 test_files: []
 
+has_rdoc: true