Skip to content

Commit

Permalink
Clarify diff between connection settings timeout and open_timeout (
Browse files Browse the repository at this point in the history
  • Loading branch information
Yu-Chieh-Henry-Yang authored Dec 22, 2022
1 parent 20a5d57 commit a34861a
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions lib/faraday/options/env.rb
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,19 @@ 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
# - `:on_data` - Proc for streaming
# - `:proxy` - Hash of proxy options
# - `:uri` - Proxy Server URI
# - `:user` - Proxy server username
# - `:password` - Proxy server password
# - `:timeout` - time limit for the entire request (Integer in
# seconds)
# - `:open_timeout` - time limit for just the connection phase (e.g.
# handshake) (Integer in seconds)
# - `:read_timeout` - time limit for the first response byte received from
# the server (Integer in seconds)
# - `:write_timeout` - time limit for the client to send the request to the
# server (Integer in seconds)
# - `:on_data` - Proc for streaming
# - `:proxy` - Hash of proxy options
# - `:uri` - Proxy server URI
# - `:user` - Proxy server username
# - `:password` - Proxy server password
#
# @!attribute request_headers
# @return [Hash] HTTP Headers to be sent to the server.
Expand Down

0 comments on commit a34861a

Please sign in to comment.