Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify diff between connection settings timeout and open_timeout #1470

Merged
merged 5 commits into from
Dec 22, 2022
Merged

Clarify diff between connection settings timeout and open_timeout #1470

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f5d0574
Clarify diff between timeout and open_timeout
Yu-Chieh-Henry-Yang Dec 16, 2022
8e55f7e
Emphasize that timeout represents open plus read
Yu-Chieh-Henry-Yang Dec 16, 2022
9203ed8
Update env.rb
Yu-Chieh-Henry-Yang Dec 20, 2022
62e4dc9
Update env.rb
Yu-Chieh-Henry-Yang Dec 21, 2022
e6743b9
Update lib/faraday/options/env.rb
iMacTia Dec 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/faraday/options/env.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ module Faraday
# @return [Hash] options for configuring the request.
# Options for configuring the request.
#
# - `:timeout` open/read timeout Integer in seconds
# - `:open_timeout` - read timeout Integer in seconds
# - `:timeout` - total timeout for both the connection-opening phase and the reading phase after it added together (Integer in seconds)
# - `:open_timeout` - timeout for only the connection-opening phase (Integer in seconds)
# - `:on_data` - Proc for streaming
# - `:proxy` - Hash of proxy options
# - `:uri` - Proxy Server URI
Expand Down