Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
better timeout descriptions
  • Loading branch information
kraih committed Jan 21, 2012
1 parent 09d7528 commit a1d5947
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 17 deletions.
2 changes: 1 addition & 1 deletion Changes
@@ -1,6 +1,6 @@
This file documents the revision history for Perl extension Mojolicious.

2.46 2012-01-20 00:00:00
2.46 2012-01-21 00:00:00
- Added EXPERIMENTAL request_timeout attribute to Mojo::UserAgent.
- Improved documentation.
- Improved tests.
Expand Down
3 changes: 2 additions & 1 deletion lib/Mojo/IOLoop/Client.pm
Expand Up @@ -239,7 +239,8 @@ Port to connect to.
=item C<timeout>
Maximum amount of time in seconds establishing connection may take.
Maximum amount of time in seconds establishing connection may take before
getting canceled.
=item C<tls>
Expand Down
14 changes: 7 additions & 7 deletions lib/Mojo/Server/Hypnotoad.pm
Expand Up @@ -537,8 +537,8 @@ C<1000>.
graceful_timeout => 15
Time in seconds a graceful worker stop may take before being forced, defaults
to C<30>.
Maximum amount of time in seconds a graceful worker stop may take before
being forced, defaults to C<30>.
=head2 C<group>
Expand All @@ -556,14 +556,14 @@ Heartbeat interval in seconds, defaults to C<5>.
heartbeat_timeout => 2
Time in seconds before a worker without a heartbeat will be stopped, defaults
to C<10>.
Maximum amount of time in seconds before a worker without a heartbeat will be
stopped, defaults to C<10>.
=head2 C<inactivity_timeout>
inactivity_timeout => 10
Maximum amount of time in seconds a connection can be inactive before being
Maximum amount of time in seconds a connection can be inactive before getting
dropped, defaults to C<15>. Setting the value to C<0> will allow connections
to be inactive indefinitely.
Expand Down Expand Up @@ -604,8 +604,8 @@ the C<MOJO_REVERSE_PROXY> environment variable.
upgrade_timeout => 30
Time in seconds a zero downtime software upgrade may take before being
aborted, defaults to C<60>.
Maximum amount of time in seconds a zero downtime software upgrade may take
before getting canceled, defaults to C<60>.
=head2 C<user>
Expand Down
19 changes: 11 additions & 8 deletions lib/Mojo/UserAgent.pm
Expand Up @@ -683,8 +683,8 @@ environment variable.
my $timeout = $ua->connect_timeout;
$ua = $ua->connect_timeout(5);
Maximum amount of time in seconds establishing a connection may take,
defaults to C<3>.
Maximum amount of time in seconds establishing a connection may take before
getting canceled, defaults to C<3>.
=head2 C<cookie_jar>
Expand Down Expand Up @@ -775,13 +775,16 @@ Domains that don't require a proxy server to be used.
=head2 C<request_timeout>
my $timeout = $ua->request_timeout;
$ua = $ua->request_timeout(25);
$ua = $ua->request_timeout(5);
Maximum amount of time in seconds receiving a whole response may take from
when a connection has been established, defaults to C<0>. Setting the value
to C<0> will allow the user agent to wait indefinitely. The timeout will
reset for every followed redirect. Note that this attribute is EXPERIMENTAL
and might change without warning!
Maximum amount of time in seconds sending the request and receiving the whole
response may take before getting canceled, defaults to C<0>. Setting the
value to C<0> will allow the user agent to wait indefinitely. The timeout
will reset for every followed redirect. Note that this attribute is
EXPERIMENTAL and might change without warning!
# Total limit of 8 seconds
$ua->max_redirects(0)->connect_timeout(3)->request_timeout(5);
=head2 C<transactor>
Expand Down

0 comments on commit a1d5947

Please sign in to comment.