try_defer: enable documentation
[rainbows.git] / lib / rainbows / event_machine.rb
blobfb7177b64c96436ad984211ab4eded3eb36e9153
1 # -*- encoding: binary -*-
2 require 'eventmachine'
3 EM::VERSION >= '0.12.10' or abort 'eventmachine 0.12.10 is required'
5 # Implements a basic single-threaded event model with
6 # {EventMachine}[http://rubyeventmachine.com/].  It is capable of
7 # handling thousands of simultaneous client connections, but with only
8 # a single-threaded app dispatch.  It is suited for slow clients,
9 # and can work with slow applications via asynchronous libraries such as
10 # {async_sinatra}[http://github.com/raggi/async_sinatra],
11 # {Cramp}[http://m.onkey.org/2010/1/7/introducing-cramp],
12 # and {rack-fiber_pool}[http://github.com/mperham/rack-fiber_pool].
14 # It does not require your Rack application to be thread-safe,
15 # reentrancy is only required for the DevFdResponse body
16 # generator.
18 # Compatibility: Whatever \EventMachine ~> 0.12.10 and Unicorn both
19 # support, currently Ruby 1.8/1.9.
21 # This model is compatible with users of "async.callback" in the Rack
22 # environment such as
23 # {async_sinatra}[http://github.com/raggi/async_sinatra].
25 # For a complete asynchronous framework,
26 # {Cramp}[http://m.onkey.org/2010/1/7/introducing-cramp] is fully
27 # supported when using this concurrency model.
29 # This model is fully-compatible with
30 # {rack-fiber_pool}[http://github.com/mperham/rack-fiber_pool]
31 # which allows each request to run inside its own \Fiber after
32 # all request processing is complete.
34 # Merb (and other frameworks/apps) supporting +deferred?+ execution as
35 # documented at Rainbows::EventMachine::TryDefer
37 # This model does not implement as streaming "rack.input" which allows
38 # the Rack application to process data as it arrives.  This means
39 # "rack.input" will be fully buffered in memory or to a temporary file
40 # before the application is entered.
42 # === RubyGem Requirements
44 # * event_machine 0.12.10
45 module Rainbows::EventMachine
46   autoload :ResponsePipe, 'rainbows/event_machine/response_pipe'
47   autoload :ResponseChunkPipe, 'rainbows/event_machine/response_chunk_pipe'
48   autoload :TryDefer, 'rainbows/event_machine/try_defer'
49   autoload :Client, 'rainbows/event_machine/client'
51   include Rainbows::Base
53   # runs inside each forked worker, this sits around and waits
54   # for connections and doesn't die until the parent dies (or is
55   # given a INT, QUIT, or TERM signal)
56   def worker_loop(worker) # :nodoc:
57     init_worker_process(worker)
58     server = Rainbows.server
59     server.app.respond_to?(:deferred?) and
60       server.app = TryDefer.new(server.app)
62     # enable them both, should be non-fatal if not supported
63     EM.epoll
64     EM.kqueue
65     logger.info "#@use: epoll=#{EM.epoll?} kqueue=#{EM.kqueue?}"
66     client_class = Rainbows.const_get(@use).const_get(:Client)
67     max = worker_connections + LISTENERS.size
68     Rainbows::EventMachine::Server.const_set(:MAX, max)
69     Rainbows::EventMachine::Server.const_set(:CL, client_class)
70     client_class.const_set(:APP, Rainbows.server.app)
71     EM.run {
72       conns = EM.instance_variable_get(:@conns) or
73         raise RuntimeError, "EM @conns instance variable not accessible!"
74       Rainbows::EventMachine::Server.const_set(:CUR, conns)
75       Rainbows.at_quit do
76         EM.next_tick { conns.each_value { |c| client_class === c and c.quit } }
77       end
78       EM.add_periodic_timer(1) do
79         EM.stop if ! Rainbows.tick && conns.empty? && EM.reactor_running?
80       end
81       LISTENERS.map! do |s|
82         EM.watch(s, Rainbows::EventMachine::Server) do |c|
83           c.notify_readable = true
84         end
85       end
86     }
87   end
88 end
89 # :enddoc:
90 require 'rainbows/event_machine/server'