added examples for different transaction errors

mojolicious · Nov 29, 2014 · 7877860 · 7877860
1 parent 39dffc8
commit 7877860
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/lib/Mojo/Message.pm b/lib/Mojo/Message.pm
@@ -503,6 +503,15 @@ make sure it is not excessively large, there's a 10MB limit by default.
 Get or set message error, an C<undef> return value indicates that there is no
 error.
 
+  # Connection error
+  $msg->error({message => 'Connection refused'});
+
+  # Parser error
+  $msg->error({message => 'Maximum message size exceeded', advice => 413});
+
+  # 4xx/5xx response
+  $msg->error({message => 'Internal Server Error', code => 500});
+
 =head2 every_cookie
 
   my $cookies = $msg->every_cookie('foo');

diff --git a/lib/Mojo/Transaction.pm b/lib/Mojo/Transaction.pm
@@ -19,7 +19,7 @@ sub client_close {
     $res->error({message => 'Premature connection close'});
   }
 
-  # 400/500
+  # 4xx/5xx
   elsif ($res->is_status_class(400) || $res->is_status_class(500)) {
     $res->error({message => $res->message, code => $res->code});
   }