diff options
author | Eric Wong <normalperson@yhbt.net> | 2011-04-18 15:53:08 -0700 |
---|---|---|
committer | Eric Wong <normalperson@yhbt.net> | 2011-04-18 15:57:22 -0700 |
commit | 6411add3f1a5aae5f2e0dcd73cd842500d21e9fd (patch) | |
tree | 80206a9b42c3a0bdd3700421241e36e473a26f3f /lib/unicorn/http_server.rb | |
parent | 1107ede716461049033d6a5b311e14c742c9363a (diff) | |
download | unicorn-6411add3f1a5aae5f2e0dcd73cd842500d21e9fd.tar.gz |
Don't clutter up our RDoc/website with things that users of Unicorn don't need to see. This should make user-relevant documentation easier to find, especially since Unicorn is NOT intended to be an API.
Diffstat (limited to 'lib/unicorn/http_server.rb')
-rw-r--r-- | lib/unicorn/http_server.rb | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/lib/unicorn/http_server.rb b/lib/unicorn/http_server.rb index 69feb2f..7ed26ca 100644 --- a/lib/unicorn/http_server.rb +++ b/lib/unicorn/http_server.rb @@ -4,15 +4,19 @@ # processes which in turn handle the I/O and application process. # Listener sockets are started in the master process and shared with # forked worker children. +# +# Users do not need to know the internals of this class, but reading the +# {source}[http://bogomips.org/unicorn.git/tree/lib/unicorn/http_server.rb] +# is education for programmers wishing to learn how \Unicorn works. +# See Unicorn::Configurator for information on how to configure \Unicorn. class Unicorn::HttpServer + # :stopdoc: attr_accessor :app, :request, :timeout, :worker_processes, :before_fork, :after_fork, :before_exec, :listener_opts, :preload_app, :reexec_pid, :orig_app, :init_listeners, :master_pid, :config, :ready_pipe, :user attr_reader :pid, :logger - - # :stopdoc: include Unicorn::SocketHelper include Unicorn::HttpResponse @@ -84,6 +88,7 @@ class Unicorn::HttpServer rescue Dir.pwd end + # :stopdoc: # Creates a working server on host:port (strange things happen if # port isn't a Number). Use HttpServer::run to start the server and |