From 2b85ea421197af84a13f6062b21ddcf61490ebcf Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 27 Dec 2010 08:57:31 +0000 Subject: doc: misc cleanups and additions for RDoc This is also our website, so we need to document the new Cool.io-based concurrency options for users and point existing Rev* users to it. --- lib/rainbows/coolio_thread_spawn.rb | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) (limited to 'lib/rainbows/coolio_thread_spawn.rb') diff --git a/lib/rainbows/coolio_thread_spawn.rb b/lib/rainbows/coolio_thread_spawn.rb index 1ca5c6c..81591d9 100644 --- a/lib/rainbows/coolio_thread_spawn.rb +++ b/lib/rainbows/coolio_thread_spawn.rb @@ -1,2 +1,20 @@ -# :enddoc: +# -*- encoding: binary -*- +# :stopdoc: Rainbows.const_set(:CoolioThreadSpawn, Rainbows::RevThreadSpawn) +# :startdoc: + +# A combination of the Coolio and ThreadSpawn models. This allows Ruby +# Thread-based concurrency for application processing. It DOES NOT +# expose a streamable "rack.input" for upload processing within the +# app. DevFdResponse should be used with this class to proxy +# asynchronous responses. All network I/O between the client and +# server are handled by the main thread and outside of the core +# application dispatch. +# +# Unlike ThreadSpawn, Cool.io makes this model highly suitable for +# slow clients and applications with medium-to-slow response times +# (I/O bound), but less suitable for sleepy applications. +# +# This concurrency model is designed for Ruby 1.9, and Ruby 1.8 +# users are NOT advised to use this due to high CPU usage. +module Rainbows::CoolioThreadSpawn; end -- cgit v1.2.3-24-ge0c7