serverengine 2.0.0pre1-x86-mingw32

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb740fe7e9ba44533ad55afa79c34feb0521931e
+  data.tar.gz: f5959aca75bcc3a340de1d91caac0da9a0905e10
+SHA512:
+  metadata.gz: 14e11560b295c04880c29987fde26649e5c98d3f2c44c956f8666fb0e80766f88e850d6871f736c376fbd652e0f1d74a249f4a0813dcccb53c7fe0b58d5b0c27
+  data.tar.gz: 3f1a342b7cc25e9b18798bb389027dde8a3d2a6d8fd1a5ca71d7ed726c09d7df1b3540bf795a2c090188057a42e059ed187dc51c80659cb246e5d9136617c9f5

data/.gitignore

@@ -0,0 +1,5 @@
+Gemfile.lock
+tmp/*
+pkg/*
+myserver.log
+myserver.pid

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+
+rvm:
+  - 2.1.10
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+
+branches:
+  only:
+    - master
+
+script: bundle exec rake spec
+
+before_install:
+ - gem update bundler
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Changelog

@@ -0,0 +1,122 @@
+2016-08-23 version 2.0.0:
+
+* Add windows-pr gem dependency to get ruby_bin_path correctly
+* Add command sender feature to use pipe to control workers for Windows
+* Delete MultiprocessLogDevice implementation to use Ruby's one always. This
+  means removal of backward workaround code for Ruby < 2.1.
+* Refactor modules and methods to clean internal file dependency Internal
+  symbol `ServerEngine::Daemon::Signals` is moved to `ServerEngine::Signals`
+* Add example script to run servers
+* Fix required Ruby version to 2.1 or later
+
+2016-05-19 version 1.6.4:
+
+* Refactor to delete some warnings
+* Fix infinite self call bug in SignalTread
+* Add ruby 2.1 support for TravisCI
+
+2016-04-27 version 1.6.3:
+
+* Fix Socket Manager for UDP to adapt to ipv6
+* Fix Socket Manager not to join thread in Ruby 2.1
+* Fix Socket Manager to identify all localhost address
+* Fix ruby dll path on Ruby x64
+
+2016-04-14 version 1.6.2:
+
+* Fix to use Etc instead of id command in change_privilege for windows
+* Fix signal handler on Server class to be configurable
+* Fix to use spawn when damonize on windows
+
+2016-03-04 version 1.6.1:
+
+* Fix CloseHandle definition in winsock
+
+
+2015-01-07 version 1.6.0:
+
+* Added SocketManager, a utility class for multiprocess servers to listen on
+  the same TCP or UDP port dynamically.
+* Added a new attr_reader accessor at Daemon#server and Supervisor#server
+* Added ServerEngine.windows? method to check Windows platform
+* ProcessManager now considers Windows platform
+
+
+2015-09-28 version 1.5.11:
+
+* Fix unexpected logger option handling [#22]
+* Fix gem homepage link
+
+
+2014-10-27 version 1.5.10:
+
+* Added worker_type=spawn (experimental)
+* Fixed Worker#config to reference Server#config so that Worker#reload reads
+  the new config reloaded by Server#reload (=ConfigLoader#reload_config) in
+  worker_type=thread and embedded
+* Server#stop, #restart and #reload show a debug log message
+
+
+2014-07-24 version 1.5.9:
+
+* Fixed DaemonLogger#reoepen! on Ruby >= 2.1.0
+
+
+2014-06-27 version 1.5.8:
+
+* Use standard LogDevice on Ruby >= 2.1.0 imporoved at https://github.com/ruby/ruby/pull/428
+
+
+2013-10-31 version 1.5.7:
+
+* Fixed :log parameter handling
+
+
+2013-10-20 version 1.5.6:
+
+* Fixed log rotation in worker_type=process mode [#9]
+* DaemonLogger supports 'trace' level
+
+
+2013-09-17 version 1.5.5:
+
+* worker_type=thread and embedded show uncaught errors caused in Worker#stop
+  and Worker#reload interface
+* ProcessManager: enables child process heartbeat only if enable_heartbeat
+  option is true
+* ProcessManager: doesn't call fcntl on pipe pairs if F_SETFD or FD_CLOEXEC
+  is not defined
+* ProcessManager: added #spawn(*args) method
+
+
+2013-09-10 version 1.5.4:
+
+* SignalThread: fixed "Unexpected error can't be called from trap context"
+  error in Ruby 2.0 (Thanks to @jondot and @sonots)
+
+
+2013-06-30 version 1.5.3:
+
+* Daemon: uses Process::UID.from_name and Process::GID.from_name
+  instead of running id command
+* worker_type=thread calls before_fork
+* Added MultiWorkerServer#join_workers
+* DaemonLogger: fixed #initialize to use config[:log_level]
+
+
+2013-06-11 version 1.5.2:
+
+* Updated default parameters of ProcessManager to be more conservative
+* Daemon: added :daemonize_error_exit_code option
+* Fixed ServerEngine.create
+
+
+2013-06-04 version 1.5.1:
+
+* Changed #close callback to #after_start
+
+
+2013-06-01 version 1.5.0:
+
+* First release
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,3 @@
+ServerEngine
+https://github.com/frsyuki/serverengine
+Copyright (C) 2012-2013 Sadayuki Furuhashi

data/README.md

@@ -0,0 +1,514 @@
+# ServerEngine
+
+ServerEngine is a framework to implement robust multiprocess servers like Unicorn.
+
+**Main features:**
+
+```
+                  Heartbeat via pipe
+                      & auto-restart
+                 /                \               ---+
++------------+  /   +----------+   \  +--------+     |
+| Supervisor |------|  Server  |------| Worker |     |
++------------+      +----------+\     +--------+     | Multi-process
+                        /         \                  | or multi-thread
+                       /            \ +--------+     |
+      Dynamic reconfiguration         | Worker |     |
+     and live restart support         +--------+     |
+                                                  ---+
+```
+
+ServerEngine also provides useful options and utilities such as **logging**, **signal handlers**, **changing process names** shown by `ps` command, chuser, **stacktrace** and **heap dump on signal**.
+
+* [Examples](#examples)
+  * [Simplest server](#simplest-server)
+  * [Multiprocess server](#multiprocess-server)
+  * [Multiprocess TCP server](#multiprocess-tcp-server)
+  * [Multiprocess server on Windows and JRuby platforms](#multiprocess-server-on-windows-and-jruby-platforms)
+* [Logging](#logging)
+* [Supervisor auto restart](#supervisor-auto-restart)
+* [Live restart](#live-restart)
+* [Dynamic config reloading](#dynamic-config-reloading)
+* [Signals](#signals)
+* [Utilities](#utilities)
+  * [BlockingFlag](#blockingflag)
+  * [SocketManager](#socketmanager)
+* [Module API](#module-api)
+  * [Worker module](#worker-module)
+  * [Server module](#server-module)
+* [List of all configurations](#list-of-all-configurations)
+
+## Examples
+
+### Simplest server
+
+What you need to implement at least is a worker module which has `run` and `stop` methods.
+
+```ruby
+require 'serverengine'
+
+module MyWorker
+  def run
+    until @stop
+      logger.info "Awesome work!"
+      sleep 1
+    end
+  end
+
+  def stop
+    @stop = true
+  end
+end
+
+se = ServerEngine.create(nil, MyWorker, {
+  daemonize: true,
+  log: 'myserver.log',
+  pid_path: 'myserver.pid',
+})
+se.run
+```
+
+Send `TERM` signal (or `KILL` on Windows) to kill the daemon. See also **Signals** section bellow for details.
+
+
+### Multiprocess server
+
+Simply set **worker_type: "process"** or **worker_type: "thread"** parameter, and set number of workers to `workers` parameter.
+
+```ruby
+se = ServerEngine.create(nil, MyWorker, {
+  daemonize: true,
+  log: 'myserver.log',
+  pid_path: 'myserver.pid',
+  worker_type: 'process',
+  workers: 4,
+})
+se.run
+```
+
+See also **Worker types** section bellow.
+
+
+### Multiprocess TCP server
+
+One of the typical implementation styles of TCP servers is that a parent process listens socket and child processes accept connections from clients.
+
+ServerEngine allows you to optionally implement a server module to control the parent process:
+
+```ruby
+# Server module controls the parent process
+module MyServer
+  def before_run
+    @sock = TCPServer.new(config[:bind], config[:port])
+  end
+
+  attr_reader :sock
+end
+
+# Worker module controls child processes
+module MyWorker
+  def run
+    until @stop
+      # you should use Cool.io or EventMachine actually
+      c = server.sock.accept
+      c.write "Awesome work!"
+      c.close
+    end
+  end
+
+  def stop
+    @stop = true
+  end
+end
+
+se = ServerEngine.create(MyServer, MyWorker, {
+  daemonize: true,
+  log: 'myserver.log',
+  pid_path: 'myserver.pid',
+  worker_type: 'process',
+  workers: 4,
+  bind: '0.0.0.0',
+  port: 9071,
+})
+se.run
+```
+
+
+### Multiprocess server on Windows and JRuby platforms
+
+Above **worker_type: "process"** depends on `fork` system call, which doesn't work on Windows or JRuby platform.
+ServerEngine provides **worker_type: "spawn"** for those platforms (This is still EXPERIMENTAL). However, unfortunately, you need to implement different worker module because `worker_type: "spawn"` is not compatible with **worker_type: "process"** in terms of API.
+
+What you need to implement at least to use worker_type: "spawn" is `def spawn(process_manager)` method. You will call `process_manager.spawn` at the method, where `spawn` is same with `Process.spawn` excepting return value.
+
+In addition, Windows does not support signals.  ServerEngine provides **command_sender: "pipe"** for Windows (and for other platforms, if you want to use it).
+When using **command_sender: "pipe"**, the child process have to handle commands sent from parent process via STDIN.
+On Windows, **command_sender: "pipe"** is default.
+
+You can call `Server#stop(stop_graceful)` and `Server#restart(stop_graceful)` instead of sending signals.
+
+```ruby
+module MyWorker
+  def spawn(process_manager)
+    env = {
+      'SERVER_ENGINE_CONFIG' => config.to_json
+    }
+    script = %[
+      require 'serverengine'
+      require 'json'
+
+      conf = JSON.parse(ENV['SERVER_ENGINE_CONFIG'], symbolize_names: true)
+      logger = ServerEngine::DaemonLogger.new(conf[:log] || STDOUT, conf)
+
+      @stop = false
+      command_pipe = STDIN.dup
+      STDIN.reopen(File::NULL)
+      Thread.new do
+        until @stop
+          case command_pipe.gets.chomp
+          when "GRACEFUL_STOP"
+            @stop = true
+          when "IMMEDIATE_STOP"
+            @stop = true
+          when "GRACEFUL_RESTART", "IMMEDIATE_RESTART"
+            # do something...
+          end
+        end
+      end
+
+      until @stop
+        logger.info 'Awesome work!'
+        sleep 1
+      end
+    ]
+    process_manager.spawn(env, "ruby", "-e", script)
+  end
+end
+
+se = ServerEngine.create(nil, MyWorker, {
+  worker_type: 'spawn',
+  command_sender: 'pipe',
+  log: 'myserver.log',
+})
+se.run
+```
+
+
+## Logging
+
+ServerEngine logger rotates logs by 1MB and keeps 5 generations by default.
+
+```ruby
+se = ServerEngine.create(MyServer, MyWorker, {
+  log: 'myserver.log',
+  log_level: 'debug',
+  log_rotate_age: 5,
+  log_rotate_size: 1*1024*1024,
+})
+se.run
+```
+
+ServerEngine's default logger extends from Ruby's standard Logger library to:
+
+* support multiprocess aware log rotation
+* support reopening of log file
+* support 'trace' level, which is lower level than 'debug'
+
+See also **Configuration** section bellow.
+
+
+## Supervisor auto restart
+
+Server programs running 24x7 hours need to survive even if a process stalled because of unexpected memory swapping or network errors.
+
+Supervisor process runs as the parent process of the server process and monitor it to restart automatically. You can enable supervisor process by setting `supervisor: true` parameter:
+
+```ruby
+se = ServerEngine.create(nil, MyWorker, {
+  daemonize: true,
+  pid_path: 'myserver.pid',
+  supervisor: true,  # enables supervisor process
+})
+se.run
+```
+
+This auto restart reature will be suppressed for workers which exits with exit code specified by `unrecoverable_exit_codes`. At this case, whole process will exit without error (exit code 0).
+
+## Live restart
+
+You can restart a server process without waiting for completion of all workers using `INT` signal (`supervisor: true` and `enable_detach: true` parameters must be enabled).
+This feature allows you to minimize downtime where workers take long time to complete a task.
+
+```
+# 1. starts server
++------------+    +----------+    +-----------+
+| Supervisor |----|  Server  |----| Worker(s) |
++------------+    +----------+    +-----------+
+
+# 2. receives SIGINT and waits for shutdown of the server for server_detach_wait
++------------+    +----------+    +-----------+
+| Supervisor |    |  Server  |----| Worker(s) |
++------------+    +----------+    +-----------+
+
+# 3. starts new server if the server doesn't exit in server_detach_wait time
++------------+    +----------+    +-----------+
+| Supervisor |\   |  Server  |----| Worker(s) |
++------------+ |  +----------+    +-----------+
+               |
+               |  +----------+    +-----------+
+               \--|  Server  |----| Worker(s) |
+                  +----------+    +-----------+
+
+# 4. old server exits eventually
++------------+
+| Supervisor |\
++------------+ |
+               |
+               |  +----------+    +-----------+
+               \--|  Server  |----| Worker(s) |
+                  +----------+    +-----------+
+```
+
+Note that network servers (which listen sockets) shouldn't use live restart because it causes "Address already in use" error at the server process. Instead, simply use `worker_type: "process"` configuration and send `USR1` to restart workers instead of the server. It restarts a worker without waiting for shutdown of the other workers. This way doesn't cause downtime because server process doesn't close listening sockets and keeps accepting new clients (See also `restart_server_process` parameter if necessary).
+
+
+## Dynamic config reloading
+
+Robust servers should not restart only to update configuration parameters.
+
+```ruby
+module MyWorker
+  def initialize
+    reload
+  end
+
+  def reload
+    @message = config[:message] || "Awesome work!"
+    @sleep = config[:sleep] || 1
+  end
+
+  def run
+    until @stop
+      logger.info @message
+      sleep @sleep
+    end
+  end
+
+  def stop
+    @stop = true
+  end
+end
+
+se = ServerEngine.create(nil, MyWorker) do
+  YAML.load_file("config.yml").merge({
+    daemonize: true,
+    worker_type: 'process',
+  })
+end
+se.run
+```
+
+Send `USR2` signal to reload configuration file.
+
+
+## Signals
+
+- **TERM:** graceful shutdown
+- **QUIT:** immediate shutdown (available only when `worker_type` is "process")
+- **USR1:** graceful restart
+- **HUP:** immediate restart (available only when `worker_type` is "process")
+- **USR2:** reload config file and reopen log file
+- **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 kills the processes.
+Graceful shutdown and restart call `Worker#stop` method and wait for completion of `Worker#run` method.
+
+Note that signals are not supported on Windows.
+You have to use piped command instead of signals on Windows.
+See also **Multiprocess server on Windows and JRuby platforms** section.
+
+
+## Utilities
+
+### BlockingFlag
+
+`ServerEngine::BlockingFlag` is recommended to stop workers because `stop` method is called by a different thread from the `run` thread.
+
+```ruby
+module MyWorker
+  def initialize
+    @stop_flag = ServerEngine::BlockingFlag.new
+  end
+
+  def run
+    until @stop_flag.wait_for_set(1.0)  # or @stop_flag.set?
+      logger.info @message
+    end
+  end
+
+  def stop
+    @stop_flag.set!
+  end
+end
+
+se = ServerEngine.create(nil, MyWorker) do
+  YAML.load_file(config).merge({
+    daemonize: true,
+    worker_type: 'process'
+  })
+end
+se.run
+```
+
+
+### SocketManager
+
+`ServerEngine::SocketManager` is a powerful library to listen on the same port across multiple worker processes dynamically.
+
+```ruby
+module MyServer
+  def before_run
+    @socket_manager_path = ServerEngine::SocketManager::Server.generate_path
+    @socket_manager_server = ServerEngine::SocketManager::Server.open(@socket_manager_path)
+  end
+
+  def after_run
+    @socket_manager_server.close
+  end
+
+  attr_reader :socket_manager_path
+end
+
+module MyWorker
+  def initialize
+    @stop_flag = ServerEngine::BlockingFlag.new
+    @socket_manager = ServerEngine::SocketManager::Client.new(server.socket_manager_path)
+  end
+
+  def run
+    lsock = @socket_manager.listen_tcp('0.0.0.0', 12345)
+    until @stop
+      c = lsock.accept
+      c.write "Awesome work!"
+      c.close
+    end
+  end
+
+  def stop
+    @stop = true
+  end
+end
+
+se = ServerEngine.create(MyServer, MyWorker, {
+  daemonize: true,
+  log: 'myserver.log',
+  pid_path: 'myserver.pid',
+  worker_type: 'process',
+  workers: 4,
+  bind: '0.0.0.0',
+  port: 9071,
+})
+se.run
+```
+
+See also [examples](https://github.com/fluent/serverengine/tree/master/examples).
+
+
+## Module API
+
+Available methods are different depending on `worker_type`. ServerEngine supports 3 worker types:
+
+- **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 Windows or JRuby platform.
+- **spawn**: uses processes to run worker modules. This type works on Windows and JRuby platform but available interface of worker module is limited (See also Worker module section).
+
+### 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 [`worker_type` = "thread", "process"]
+  - `run` is the required method for `worker_type` = "embedded", "thread", "process"
+  - `spawn(process_manager)` is the required method for `worker_type` = "spawn". Should call `process_manager.spawn([env,] command... [,options])`.
+  - `stop` is called when TERM signal is received [`worker_type` = "embedded", "thread", "process"]
+  - `reload` is called when USR2 signal is received [`worker_type` = "embedded", "thread", "process"]
+  - `after_start` is called after starting the worker process in the parent process (or thread) [`worker_type` = "thread", "process", "spawn"]
+- 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 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
+
+
+## List of all configurations
+
+- Daemon
+  - **daemonize** enables daemonize (default: false)
+  - **pid_path** sets the path to pid file (default: don't create pid file)
+  - **supervisor** enables supervisor if it's true (default: false)
+  - **daemon_process_name** changes process name ($0) of server or supervisor process
+  - **chuser** changes execution user
+  - **chgroup** changes execution group
+  - **chumask** changes umask
+  - **daemonize_error_exit_code** exit code when daemonize, changing user or changing group fails (default: 1)
+- Supervisor: available only when `supervisor` parameters is true
+  - **server_process_name** changes process name ($0) of server process
+  - **restart_server_process** restarts server process when it receives USR1 or HUP signal. (default: false)
+  - **enable_detach** enables INT signal (default: true)
+  - **exit_on_detach** exits supervisor after detaching server process instead of restarting it (default: false)
+  - **disable_reload** disables USR2 signal (default: false)
+  - **server_restart_wait** sets wait time before restarting server after last restarting (default: 1.0) [dynamic reloadable]
+  - **server_detach_wait** sets wait time before starting live restart (default: 10.0) [dynamic reloadable]
+- Multithread server and multiprocess server: available only when `worker_type` is thread or process
+  - **workers** sets number of workers (default: 1) [dynamic reloadable]
+  - **start_worker_delay** sets wait time before starting a new worker (default: 0) [dynamic reloadable]
+  - **start_worker_delay_rand** randomizes start_worker_delay at this ratio (default: 0.2) [dynamic reloadable]
+- Multiprocess server: available only when `worker_type` is "process"
+  - **worker_process_name** changes process name ($0) of workers [dynamic reloadable]
+  - **worker_heartbeat_interval** sets interval of heartbeats in seconds (default: 1.0) [dynamic reloadable]
+  - **worker_heartbeat_timeout** sets timeout of heartbeat in seconds (default: 180) [dynamic reloadable]
+  - **worker_graceful_kill_interval** sets the first interval of TERM signals in seconds (default: 15) [dynamic reloadable]
+  - **worker_graceful_kill_interval_increment** sets increment of TERM signal interval in seconds (default: 10) [dynamic reloadable]
+  - **worker_graceful_kill_timeout** sets promotion timeout from TERM to QUIT signal in seconds. -1 means no timeout (default: 600) [dynamic reloadable]
+  - **worker_immediate_kill_interval** sets the first interval of QUIT signals in seconds (default: 10) [dynamic reloadable]
+  - **worker_immediate_kill_interval_increment** sets increment of QUIT signal interval in seconds (default: 10) [dynamic reloadable]
+  - **worker_immediate_kill_timeout** sets promotion timeout from QUIT to KILL signal in seconds. -1 means no timeout (default: 600) [dynamic reloadable]
+  - **unrecoverable_exit_codes** handles worker processes, which exits with code included in this value, as unrecoverable (not to restart) (default: [])
+  - **stop_immediately_at_unrecoverable_exit** stops server immediately if a worker exits with unrecoverable exit status (default: false)
+- Multiprocess spawn server: available only when `worker_type` is "spawn"
+  - all parameters of multiprocess server excepting worker_process_name
+  - **worker_reload_signal** sets the signal to notice configuration reload to a spawned process. Set nil to disable (default: nil)
+- Logger
+  - **log** sets path to log file. Set "-" for STDOUT (default: STDERR) [dynamic reloadable]
+  - **log_level** log level: trace, debug, info, warn, error or fatal. (default: debug) [dynamic reloadable]
+  - **log_rotate_age** generations to keep rotated log files (default: 5)
+  - **log_rotate_size** sets the size to rotate log files (default: 1048576)
+  - **log_stdout** hooks STDOUT to log file (default: true)
+  - **log_stderr** hooks STDERR to log file (default: true)
+  - **logger_class** class of the logger instance (default: ServerEngine::DaemonLogger)
+
+---
+
+```
+Author:    Sadayuki Furuhashi
+Copyright: Copyright (c) 2012-2013 Sadayuki Furuhashi
+License:   Apache License, Version 2.0
+```
+