about summary refs log tree commit homepage
diff options
authorEric Wong <e@80x24.org>2016-01-27 20:43:44 +0000
committerEric Wong <e@80x24.org>2016-01-27 22:54:53 +0000
commit8be441f052ee9c375993359f7642d3599ef3f6aa (patch)
parent3d69a6f064078eeb28c1819725d3715ce6905374 (diff)
State explicitly applications should not rely on it, and instead
rescue the generic EOFError exception.  This class will stick
around because there may inevitably be things which rely on it,
but we should not encourage it, either.
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/unicorn.rb b/lib/unicorn.rb
index bb66b61..f122563 100644
--- a/lib/unicorn.rb
+++ b/lib/unicorn.rb
@@ -25,7 +25,9 @@ module Unicorn
   # application dispatch.  This is always raised with an empty backtrace
   # since there is nothing in the application stack that is responsible
   # for client shutdowns/disconnects.  This exception is visible to Rack
-  # applications unless PrereadInput middleware is loaded.
+  # applications unless PrereadInput middleware is loaded.  This
+  # is a subclass of the standard EOFError class and applications should
+  # not rescue it explicitly, but rescue EOFError instead.
   ClientShutdown = Class.new(EOFError)
   # :stopdoc: