merged in
John Napiorkowski [Fri, 17 May 2013 17:00:38 +0000 (13:00 -0400)]
Changes
lib/Catalyst/Engine.pm
lib/Catalyst/Request.pm
lib/Catalyst/Upgrading.pod

diff --git a/Changes b/Changes
index ae21dcc..ae86e24 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,10 +1,14 @@
 # This file documents the revision history for Perl extension Catalyst.
 
+TBA
   ! Stricter checking of attributes in Catalyst::DispatchType::Chained:
     1) Only allow one of either :CaptureArgs or :Args
     2) :CaptureArgs() argument must be numeric
   - Add Devel::InnerPackage to dependencies, fixing tests on perl 5.17.11
     as it's been removed from core. RT#84787
+  - New support for closing over the PSGI $writer object, useful for working
+    with event loops.
+
 
 5.90030 - 2013-04-12
   ! POSSIBLE BREAKING CHANGE: Removed Regexp dispatch type from core, and put
index b8d29a4..e63da83 100644 (file)
@@ -58,7 +58,7 @@ Finalize body.  Prints the response output as blocking stream if it looks like
 a filehandle, otherwise write it out all in one go.  If there is no body in
 the response, we assume you are handling it 'manually', such as for nonblocking
 style or asynchronous streaming responses.  You do this by calling L<\write>
-several times (which sends HTTP headers if needed) or you close over L<\write_fh>.
+several times (which sends HTTP headers if needed) or you close over C<$response->write_fh>.
 
 See L<Catalyst::Response\write> and L<Catalyst::Response\write_fh> for more.
 
index b8d05b4..dce7a05 100644 (file)
@@ -640,7 +640,7 @@ defaults to the size of the request if not specified.
 
 =head2 $req->read_chunk(\$buff, $max)
 
-Reads a chunk..
+Reads a chunk.
 
 You have to set MyApp->config(parse_on_demand => 1) to use this directly.
 
@@ -651,10 +651,12 @@ Shortcut for $req->headers->referer. Returns the referring page.
 =head2 $req->secure
 
 Returns true or false, indicating whether the connection is secure
-(https). Note that the URI scheme (e.g., http vs. https) must be determined
-through heuristics, and therefore the reliability of $req->secure will depend
-on your server configuration. If you are setting the HTTPS environment variable, 
-$req->secure should be valid.
+(https). The reliability of $req->secure may depend on your server
+configuration; Catalyst relies on PSGI to determine whether or not a
+request is secure (Catalyst looks at psgi.url_scheme), and different
+PSGI servers may make this determination in different ways (as by
+directly passing along information from the server, interpreting any of
+several HTTP headers, or using heuristics of their own).
 
 =head2 $req->captures
 
index d1dd519..4526695 100644 (file)
@@ -2,15 +2,15 @@
 
 Catalyst::Upgrading - Instructions for upgrading to the latest Catalyst
 
-=head1 Upgrading to Catalyst 5.90040
+=head1 Upgrading to Catalyst TBA
 
 This version of L<Catalyst> offers some support for using L<AnyEvent> and
 L<IO::Async> event loops in your application.  These changes should work
 fine for most applications however if you are already trying to perform
 some streaming, minor changes in this area of the code might affect your
-functionality.
-
-  TDB: more on streaming, transfer encoding chunked, etc.
+functionality.  Please see L<Catalyst::Response\write_fh> for more and for a
+basic example.
 
 =head1 Upgrading to Catalyst 5.9