class HTTPX::Options::Timeouts

  1. lib/httpx/options.rb
Superclass: Struct.new( :connect_timeout, :settings_timeout, :read_timeout, :write_timeout, :request_timeout, :total_request_timeout, :operation_timeout, :keep_alive_timeout, :ping_timeout, :close_handshake_timeout, keyword_init: true

Public Class methods

new( connect_timeout: nil, settings_timeout: nil, read_timeout: nil, write_timeout: nil, request_timeout: nil, total_request_timeout: nil, operation_timeout: nil, close_handshake_timeout: nil, keep_alive_timeout: nil, ping_timeout: nil )
[show source]
    # File lib/httpx/options.rb
556 def initialize(
557   connect_timeout: nil,
558   settings_timeout: nil,
559   read_timeout: nil,
560   write_timeout: nil,
561   request_timeout: nil,
562   total_request_timeout: nil,
563   operation_timeout: nil,
564   close_handshake_timeout: nil,
565   keep_alive_timeout: nil,
566   ping_timeout: nil
567 )
568   super
569   freeze
570 end

Public Instance methods

close_handshake_timeout()
[show source]
    # File lib/httpx/options.rb
588 def close_handshake_timeout
589   self[:close_handshake_timeout] || CLOSE_HANDSHAKE_TIMEOUT
590 end
connect_timeout()
[show source]
    # File lib/httpx/options.rb
572 def connect_timeout
573   self[:connect_timeout] || (CONNECT_TIMEOUT unless deadline_timeouts?)
574 end
keep_alive_timeout()
[show source]
    # File lib/httpx/options.rb
592 def keep_alive_timeout
593   self[:keep_alive_timeout] || KEEP_ALIVE_TIMEOUT
594 end
merge(other)
[show source]
    # File lib/httpx/options.rb
600 def merge(other)
601   other_h = other.to_h
602   other_h.compact!
603   Timeouts.new(**to_h, **other_h)
604 end
ping_timeout()
[show source]
    # File lib/httpx/options.rb
596 def ping_timeout
597   self[:ping_timeout] || PING_TIMEOUT
598 end
read_timeout()
[show source]
    # File lib/httpx/options.rb
580 def read_timeout
581   self[:read_timeout] || (READ_TIMEOUT unless deadline_timeouts?)
582 end
settings_timeout()
[show source]
    # File lib/httpx/options.rb
576 def settings_timeout
577   self[:settings_timeout] || (SETTINGS_TIMEOUT unless deadline_timeouts?)
578 end
write_timeout()
[show source]
    # File lib/httpx/options.rb
584 def write_timeout
585   self[:write_timeout] || (WRITE_TIMEOUT unless deadline_timeouts?)
586 end