serverengine 1.5.0 → 1.5.1

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+tmp/*
+pkg/*

data/Changelog

@@ -1,4 +1,9 @@
 
+2013-06-04 version 1.5.1:
+
+* Changed #close callback to #after_start
+
+
 2013-06-01 version 1.5.0:
 
 * First release

data/Gemfile

@@ -1,3 +1,2 @@
 source 'https://rubygems.org/'
-
 gemspec

data/README.md

@@ -155,17 +155,17 @@ You can restart a server process without waiting for completion of shutdown proc
 This feature is useful to minimize downtime where workers take long time to complete tasks.
 
 ```
-# 1. start server
+# 1. starts server
 +------------+    +----------+    +-----------+
 | Supervisor |----|  Server  |----| Worker(s) |
 +------------+    +----------+    +-----------+
 
-# 2. detach (SIGINT) and waits for completion for several seconds
+# 2. receives SIGINT and waits for shutdown of the server for server_detach_wait
 +------------+    +----------+    +-----------+
 | Supervisor |    |  Server  |----| Worker(s) |
 +------------+    +----------+    +-----------+
 
-# 3. start new server if the server doesn't exit in a short time
+# 3. starts new server if the server doesn't exit in server_detach_wait time
 +------------+    +----------+    +-----------+
 | Supervisor |\   |  Server  |----| Worker(s) |
 +------------+ |  +----------+    +-----------+
@@ -174,7 +174,7 @@ This feature is useful to minimize downtime where workers take long time to comp
                \--|  Server  |----| Worker(s) |
                   +----------+    +-----------+
 
-# 4. old server exits
+# 4. old server exits eventually
 +------------+
 | Supervisor |\
 +------------+ |
@@ -230,7 +230,7 @@ Send `USR2` signal to reload configuration file.
 
 ### BlockingFlag
 
-`ServerEngine::BlockingFlag` is recommended to stop workers because `stop` methods is called by a different thread from the `run` thread.
+`ServerEngine::BlockingFlag` is recommended to stop workers because `stop` method is called by a different thread from the `run` thread.
 
 ```ruby
 module MyWorker
@@ -259,12 +259,46 @@ se.run
 ```
 
 
+## Module methods
+
+### Worker module
+
+- interface
+  - `initialize` is called in the parent process (or thread) in contrast to the other methods
+  - `before_fork` is called before fork for each worker process (available only if `worker_type` is "process")
+  - `run` is the required method
+  - `stop` is called when TERM signal is received
+  - `reload` is called when USR2 signal is received
+  - `after_start` is called after starting the worker process in the parent process (or thread) (available only if `worker_type` is "process" or "thread")
+- api
+  - `server` server instance
+  - `config` configuration
+  - `logger` logger
+  - `worker_id` serial id of workers beginning from 0
+
+
+### Server module
+
+- interface
+  - `initialize` is called in the parent process in contrast to the other methods
+  - `before_run` is called before starting workers
+  - `after_run` is called before shutting down
+  - `after_start` is called after starting the server process in the parent process (available only if `supervisor` parameter is true)
+- hook points (call `super` in these methods)
+  - `reload_config`
+  - `stop(stop_graceful)`
+  - `restart(stop_graceful)`
+- api
+  - `config` configuration
+  - `logger` logger
+
+
 ## Worker types
 
 ServerEngine supports 3 worker types:
 
-- **embedded**: uses a thread to run worker module (default). This type doesn't support immediate shutdown and immediate restart.
-- **thread**: uses threads to run worker modules. This type doesn't support immediate shutdown and immediate restart.
+- **embedded**: uses a thread to run worker module (default). This type doesn't support immediate shutdown or immediate restart.
+- **thread**: uses threads to run worker modules. This type doesn't support immediate shutdown or immediate restart.
 - **process**: uses processes to run worker modules. This type doesn't work on Win32 platform.
 
 
@@ -278,7 +312,7 @@ ServerEngine supports 3 worker types:
 - **INT:** detach process for live restarting (available only when `supervisor` and `enable_detach` parameters are true. otherwise graceful shutdown)
 - **CONT:** dump stacktrace and memory information to /tmp/sigdump-<pid>.log file
 
-Immediate shutdown and restart send SIGQUIT signal to worker processes which killes the processes.
+Immediate shutdown and restart send SIGQUIT signal to worker processes which kills the processes.
 Graceful shutdown and restart call `Worker#stop` method and wait for completion of `Worker#run` method.
 
 
@@ -298,13 +332,14 @@ Graceful shutdown and restart call `Worker#stop` method and wait for completion
   - **enable_detach** enables INT signal (default: true) (not dynamic reloadable)
   - **exit_on_detach** exits supervisor after detaching server process instead of restarting it (default: false) (not dynamic reloadable)
   - **disable_reload** disables USR2 signal (default: false) (not dynamic reloadable)
-  - **serverrestart_wait** sets wait time before restarting server after last restarting (default: 1.0)
+  - **server_restart_wait** sets wait time before restarting server after last restarting (default: 1.0)
   - **server_detach_wait** sets wait time before starting live restart (default: 10.0)
 - Multithread server and multiprocess server: available only when `worker_type` is thread or process
   - **workers** sets number of workers (default: 1)
   - **start_worker_delay** sets wait time before starting a new worker (default: 0)
   - **start_worker_delay_rand** randomizes start_worker_delay at this ratio (default: 0.2)
 - Multiprocess server: available only when `worker_type` is "process"
+  - **worker_process_name** changes process name ($0) of workers
   - **worker_heartbeat_interval**
   - **worker_heartbeat_timeout**
   - **worker_graceful_kill_interval**

data/lib/serverengine/config_loader.rb

@@ -28,6 +28,8 @@ module ServerEngine
           @load_config_proc = load_config_proc
         end
       end
+
+      reload_config
     end
 
     attr_reader :config

data/lib/serverengine/daemon.rb

@@ -28,8 +28,6 @@ module ServerEngine
 
       super(load_config_proc, &block)
 
-      reload_config
-
       @daemonize = @config.fetch(:daemonize, false)
 
       if @config.fetch(:supervisor, false)
@@ -121,9 +119,9 @@ module ServerEngine
 
             s = create_server(create_logger)
 
-            STDIN.reopen("/dev/null")
-            STDOUT.reopen("/dev/null", "wb")
-            STDERR.reopen("/dev/null", "wb")
+            STDIN.reopen(File::NULL)
+            STDOUT.reopen(File::NULL, "wb")
+            STDERR.reopen(File::NULL, "wb")
 
             s.install_signal_handlers
 

data/lib/serverengine/multi_process_server.rb

@@ -23,9 +23,9 @@ module ServerEngine
         auto_tick: false,
         graceful_kill_signal: Daemon::Signals::GRACEFUL_STOP,
         auto_heartbeat: true,
-        abort_on_heartbeat_error: Proc.new do
+        on_heartbeat_error: Proc.new do
           @logger.fatal "parent process unexpectedly terminated"
-          exit! 1
+          exit 1
         end
       )
 
@@ -78,7 +78,7 @@ module ServerEngine
         end
 
       ensure
-        w.close
+        w.after_start
       end
 
       return WorkerMonitor.new(w, wid, pmon)

data/lib/serverengine/multi_thread_server.rb

@@ -23,11 +23,10 @@ module ServerEngine
     def start_worker(wid)
       w = create_worker(wid)
 
-      w.before_fork
       begin
         thread = Thread.new(&w.method(:main))
       ensure
-        w.close
+        w.after_start
       end
 
       return WorkerMonitor.new(w, thread)

data/lib/serverengine/process_manager.rb

@@ -35,15 +35,15 @@ module ServerEngine
 
       @auto_heartbeat = config.fetch(:auto_heartbeat, true)
 
-      case op = config.fetch(:abort_on_heartbeat_error, true)
+      case op = config[:on_heartbeat_error]
+      when nil
+        @heartbeat_error_proc = lambda {|t| }
       when Proc
         @heartbeat_error_proc = op
-      when true
+      when :abort
         @heartbeat_error_proc = lambda {|t| exit 1 }
-      when false
-        @heartbeat_error_proc = lambda {|t| }
       else
-        raise ArgumentError, "unexpected :abort_on_heartbeat_error option (expected Proc, true or false but got #{op.class})"
+        raise ArgumentError, "unexpected :on_heartbeat_error option (expected Proc, true or false but got #{op.class})"
       end
 
       configure(config)

data/lib/serverengine/server.rb

@@ -26,8 +26,6 @@ module ServerEngine
       @stop = false
 
       super(load_config_proc, &block)
-
-      reload_config
     end
 
     def before_run
@@ -41,7 +39,7 @@ module ServerEngine
       nil
     end
 
-    def close
+    def after_start
     end
 
     def restart(stop_graceful)
@@ -79,9 +77,6 @@ module ServerEngine
       ensure
         after_run
       end
-
-    ensure
-      close
     end
 
     module WorkerInitializer

data/lib/serverengine/supervisor.rb

@@ -32,13 +32,10 @@ module ServerEngine
         graceful_kill_signal: Daemon::Signals::GRACEFUL_STOP,
         immediate_kill_signal: Daemon::Signals::IMMEDIATE_STOP,
         auto_heartbeat: true,
-        abort_on_heartbeat_error: false,
       )
 
       super(load_config_proc, &block)
 
-      reload_config
-
       @create_server_proc = Supervisor.create_server_proc(server_module, worker_module, @config)
       @server_process_name = @config[:server_process_name]
 
@@ -204,7 +201,7 @@ module ServerEngine
 
         return m
       ensure
-        s.close
+        s.after_start
       end
     end
 

data/lib/serverengine/version.rb

@@ -1,3 +1,3 @@
 module ServerEngine
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

data/lib/serverengine/worker.rb

@@ -41,7 +41,7 @@ module ServerEngine
     def reload
     end
 
-    def close
+    def after_start
     end
 
     def install_signal_handlers
@@ -65,8 +65,6 @@ module ServerEngine
 
     def main
       run
-    ensure
-      close
     end
   end
 

data/lib/serverengine.rb

@@ -46,7 +46,7 @@ module ServerEngine
     require File.join(here, v)
   }
 
-  def self.create(server_module, worker_module, &config_load_proc)
-    Daemon.new(server_module, worker_module, &config_load_proc)
+  def self.create(server_module, worker_module, load_config_proc={}, &block)
+    Daemon.new(server_module, worker_module, load_config_proc={}, &block)
   end
 end

data/serverengine.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = ">= 1.9.3"
 
-  gem.add_dependency("sigdump", ["~> 0.2.2"])
+  gem.add_dependency "sigdump", ["~> 0.2.2"]
 
-  gem.add_development_dependency("rake", [">= 0.9.2"])
-  gem.add_development_dependency("rspec", ["~> 2.13.0"])
+  gem.add_development_dependency "rake", [">= 0.9.2"]
+  gem.add_development_dependency "rspec", ["~> 2.13.0"]
 end

data/spec/server_worker_context.rb

@@ -50,8 +50,8 @@ shared_context 'test server and worker' do
       incr_test_state :server_after_run
     end
 
-    def close
-      incr_test_state :server_close
+    def after_start
+      incr_test_state :server_after_start
     end
 
     def stop(stop_graceful)
@@ -110,8 +110,8 @@ shared_context 'test server and worker' do
       incr_test_state :worker_reload
     end
 
-    def close
-      incr_test_state :worker_close
+    def after_start
+      incr_test_state :worker_after_start
     end
   end
 

data/spec/supervisor_spec.rb

@@ -16,7 +16,7 @@ describe ServerEngine::Supervisor do
       wait_for_fork
 
       test_state(:server_before_run).should == 1
-      test_state(:server_close).should == 1  # parent
+      test_state(:server_after_start).should == 1  # parent
     ensure
       sv.stop(true)
       t.join
@@ -27,7 +27,7 @@ describe ServerEngine::Supervisor do
     test_state(:server_restart).should == 0
 
     test_state(:server_after_run).should == 1
-    test_state(:server_close).should == 2  # parent and child
+    test_state(:server_after_start).should == 1
   end
 
   it 'immediate stop' do
@@ -43,7 +43,7 @@ describe ServerEngine::Supervisor do
     test_state(:server_stop).should == 1
     test_state(:server_stop_immediate).should == 1
     test_state(:server_after_run).should == 1
-    test_state(:server_close).should == 2
+    test_state(:server_after_start).should == 1
   end
 
   it 'graceful restart' do
@@ -64,7 +64,7 @@ describe ServerEngine::Supervisor do
 
     test_state(:server_before_run).should == 1
     test_state(:server_after_run).should == 1
-    test_state(:server_close).should == 2
+    test_state(:server_after_start).should == 1
   end
 
   it 'immediate restart' do
@@ -85,7 +85,7 @@ describe ServerEngine::Supervisor do
 
     test_state(:server_before_run).should == 1
     test_state(:server_after_run).should == 1
-    test_state(:server_close).should == 2
+    test_state(:server_after_start).should == 1
   end
 
   it 'reload' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serverengine
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-02 00:00:00.000000000 Z
+date: 2013-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sigdump
@@ -66,6 +66,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - COPYING
 - Changelog
 - Gemfile
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -438822575013834971
+      hash: 2571011204453974309
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23