Permalink
Browse files

Make a note about ActiveResource::Timeouterror being raised when ARes…

… calls timeout.
  • Loading branch information...
1 parent 963d7ca commit aca44bcd92ef783abdf484b58abdde6786db0f89 @chuyeow chuyeow committed May 7, 2008
Showing with 4 additions and 1 deletion.
  1. +4 −1 activeresource/lib/active_resource/base.rb
View
5 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.

0 comments on commit aca44bc

Please sign in to comment.