about summary refs log tree commit homepage
path: root/lib/rainbows/coolio.rb
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2010-12-27 08:57:31 +0000
committerEric Wong <normalperson@yhbt.net>2010-12-27 09:17:45 +0000
commit2b85ea421197af84a13f6062b21ddcf61490ebcf (patch)
treec0c23b154fa0955fde13e02fc80c2941ae5498c0 /lib/rainbows/coolio.rb
parent87a38d1a5658938a3540b45ab04cc85a9135c8f0 (diff)
downloadrainbows-2b85ea421197af84a13f6062b21ddcf61490ebcf.tar.gz
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.
Diffstat (limited to 'lib/rainbows/coolio.rb')
-rw-r--r--lib/rainbows/coolio.rb23
1 files changed, 22 insertions, 1 deletions
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