Skip to content

Commit

Permalink
[DOC] Enhanced RDoc for write_timeout (#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
BurdetteLamar authored Feb 3, 2023
1 parent b4436ba commit 6da39b0
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions lib/net/http.rb
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@ def HTTP.post_form(url, params)
# \HTTP session management
#

# Returns intger +80+, the default port to use for \HTTP requests:
# Returns integer +80+, the default port to use for \HTTP requests:
#
# Net::HTTP.default_port # => 80
#
Expand Down Expand Up @@ -1048,7 +1048,20 @@ def read_timeout=(sec)
# Sets the write timeout, in seconds, for +self+ to integer +sec+;
# the initial value is 60.
#
# Argument +sec+ must be a non-negative numeric value.
# Argument +sec+ must be a non-negative numeric value:
#
# _uri = uri.dup
# _uri.path = '/posts'
# body = 'bar' * 200000
# data = <<EOF
# {"title": "foo", "body": "#{body}", "userId": "1"}
# EOF
# headers = {'content-type': 'application/json'}
# http = Net::HTTP.new(hostname)
# http.post(_uri.path, data, headers)
# # => #<Net::HTTPCreated 201 Created readbody=true>
# http.write_timeout = 0
# http.post(_uri.path, data, headers) # Raises Net::WriteTimeout.
#
def write_timeout=(sec)
@socket.write_timeout = sec if @socket
Expand Down

0 comments on commit 6da39b0

Please sign in to comment.