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.rb | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) (limited to 'lib/rainbows/coolio.rb') diff --git a/lib/rainbows/coolio.rb b/lib/rainbows/coolio.rb index fb0a305..2fdc741 100644 --- a/lib/rainbows/coolio.rb +++ b/lib/rainbows/coolio.rb @@ -1,2 +1,23 @@ -# :enddoc: +# -*- encoding: binary -*- +# :stopdoc: Rainbows.const_set(:Coolio, Rainbows::Rev) +# :startdoc: + +# Implements a basic single-threaded event model with +# {Cool.io}[http://coolio.github.com/]. It is capable of handling +# thousands of simultaneous client connections, but with only a +# single-threaded app dispatch. It is suited for slow clients and +# fast applications (applications that do not have slow network +# dependencies) or applications that use DevFdResponse for deferrable +# response bodies. It does not require your Rack application to be +# thread-safe, reentrancy is only required for the DevFdResponse body +# generator. +# +# Compatibility: Whatever Cool.io itself supports, currently Ruby +# 1.8/1.9. +# +# This model does not implement as streaming "rack.input" which +# allows the Rack application to process data as it arrives. This +# means "rack.input" will be fully buffered in memory or to a +# temporary file before the application is entered. +module Rainbows::Coolio; end -- cgit v1.2.3-24-ge0c7