diff options
| author | John Barnette <jbarnette@gmail.com> | 2008-05-06 22:47:25 -0700 |
|---|---|---|
| committer | John Barnette <jbarnette@gmail.com> | 2008-05-06 22:47:25 -0700 |
| commit | 1851f5aca5397281d2ec0fb7843d7724144b8694 (patch) | |
| tree | 154bc47679a5bc860781c21dd89fc17b87f1e409 /activeresource | |
| parent | 8f463550b597db2156b67733f31aed13487fbc3a (diff) | |
| parent | aca44bcd92ef783abdf484b58abdde6786db0f89 (diff) | |
| download | rails-1851f5aca5397281d2ec0fb7843d7724144b8694.tar.gz rails-1851f5aca5397281d2ec0fb7843d7724144b8694.tar.bz2 rails-1851f5aca5397281d2ec0fb7843d7724144b8694.zip | |
Merge branch 'master' of git@github.com:lifo/docrails
Diffstat (limited to 'activeresource')
| -rw-r--r-- | activeresource/lib/active_resource/base.rb | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/activeresource/lib/active_resource/base.rb b/activeresource/lib/active_resource/base.rb index 570732e236..9859b6dcd2 100644 --- a/activeresource/lib/active_resource/base.rb +++ b/activeresource/lib/active_resource/base.rb @@ -183,12 +183,15 @@ module ActiveResource # self.timeout = 5 # end # - # This sets the +timeout+ to 5 seconds. You can adjust the timeout to a value suitable for the RESTful API + # This sets the +timeout+ to 5 seconds. You can adjust the +timeout+ to a value suitable for the RESTful API # you are accessing. It is recommended to set this to a reasonably low value to allow your Active Resource # clients (especially if you are using Active Resource in a Rails application) to fail-fast (see # http://en.wikipedia.org/wiki/Fail-fast) rather than cause cascading failures that could incapacitate your # server. # + # When a timeout occurs, an ActiveResource::TimeoutError is raised. You should rescue from + # ActiveResource::TimeoutError in your Active Resource method calls. + # # Internally, Active Resource relies on Ruby's Net::HTTP library to make HTTP requests. Setting +timeout+ # sets the <tt>read_timeout</tt> of the internal Net::HTTP instance to the same value. The default # <tt>read_timeout</tt> is 60 seconds on most Ruby implementations. |