Class: YARD::Server::WebrickAdapter
- Inherits:
-
Adapter
- Object
- Adapter
- YARD::Server::WebrickAdapter
- Defined in:
- lib/yard/server/webrick_adapter.rb
Overview
The main adapter to initialize a WEBrick server.
Instance Attribute Summary (collapse)
-
- (String) document_root
inherited
from Adapter
The location where static files are located, if any.
-
- (Hash{String=>Array<LibraryVersion>}) libraries
inherited
from Adapter
A map of libraries.
-
- (Hash) options
inherited
from Adapter
Options passed and processed by adapters.
-
- (Router) router
inherited
from Adapter
The router object used to route URLs to commands.
-
- (Hash) server_options
inherited
from Adapter
A set of options to pass to the server backend.
Instance Method Summary (collapse)
-
- (Object) start
Initializes a WEBrick server.
Constructor Details
This class inherits a constructor from YARD::Server::Adapter
Instance Attribute Details
- (String) document_root Originally defined in class Adapter
Returns the location where static files are located, if any. To set this field on initialization, pass :DocumentRoot to the server_opts argument in #initialize
- (Hash{String=>Array<LibraryVersion>}) libraries Originally defined in class Adapter
Returns a map of libraries.
- (Hash) options Originally defined in class Adapter
Returns options passed and processed by adapters. The actual options mostly depend on the adapters themselves.
- (Router) router Originally defined in class Adapter
Returns the router object used to route URLs to commands
- (Hash) server_options Originally defined in class Adapter
Returns a set of options to pass to the server backend. Note that :DocumentRoot also sets the #document_root.
Instance Method Details
- (Object) start
Initializes a WEBrick server. If Adapter#server_options contains a :daemonize key set to true, the server will be daemonized.
9 10 11 12 13 14 15 |
# File 'lib/yard/server/webrick_adapter.rb', line 9 def start [:ServerType] = WEBrick::Daemon if [:daemonize] server = WEBrick::HTTPServer.new() server.mount('/', WebrickServlet, self) trap("INT") { server.shutdown } server.start end |