mirror of
https://github.com/HoneyryderChuck/httpx.git
synced 2025-11-27 00:03:01 -05:00
0d58408c58
most of the code was moved to the transcoder layer. The `compression_threshold_size` option has been removed. The `:compression/brotli` plugin becomes only ´:brotli`, and depends on the new transcoding APIs. options to skip compression and decompression were added.
138 lines
3.0 KiB
Plaintext
138 lines
3.0 KiB
Plaintext
module HTTPX
|
|
class Options
|
|
# include _ToHash
|
|
|
|
BUFFER_SIZE: Integer
|
|
WINDOW_SIZE: Integer
|
|
MAX_BODY_THRESHOLD_SIZE: Integer
|
|
CONNECT_TIMEOUT: Integer
|
|
OPERATION_TIMEOUT: Integer
|
|
KEEP_ALIVE_TIMEOUT: Integer
|
|
SETTINGS_TIMEOUT: Integer
|
|
DEFAULT_OPTIONS: Hash[Symbol, untyped]
|
|
|
|
type timeout_type = :connect_timeout | :settings_timeout | :operation_timeout | :keep_alive_timeout | :read_timeout | :write_timeout | :request_timeout
|
|
type timeout = Hash[timeout_type, Numeric]
|
|
|
|
def self.new: (?options) -> instance
|
|
|
|
# headers
|
|
attr_reader uri: URI?
|
|
|
|
# headers
|
|
attr_reader headers: Headers?
|
|
|
|
# timeout
|
|
attr_reader timeout: timeout
|
|
|
|
# http2_settings
|
|
attr_reader http2_settings: Hash[Symbol, Integer | bool]
|
|
|
|
# max_concurrent_requests
|
|
attr_reader max_concurrent_requests: Integer?
|
|
|
|
# max_requests
|
|
attr_reader max_requests: Integer?
|
|
|
|
# window_size
|
|
attr_reader window_size: Integer
|
|
|
|
# buffer_size
|
|
attr_reader buffer_size: Integer
|
|
|
|
# body_threshold_size
|
|
attr_reader body_threshold_size: Integer
|
|
|
|
# transport
|
|
attr_reader transport: "unix" | nil
|
|
|
|
# addresses
|
|
attr_reader addresses: Array[ipaddr]?
|
|
|
|
# supported_compression_formats
|
|
attr_reader supported_compression_formats: Array[String]
|
|
|
|
# compress_request_body
|
|
attr_reader compress_request_body: bool
|
|
|
|
# decompress_response_body
|
|
attr_reader decompress_response_body: bool
|
|
|
|
# params
|
|
attr_reader params: Transcoder::urlencoded_input?
|
|
|
|
# form
|
|
attr_reader form: Transcoder::urlencoded_input?
|
|
|
|
# json
|
|
attr_reader json: _ToJson?
|
|
|
|
# body
|
|
attr_reader body: bodyIO?
|
|
|
|
# body
|
|
attr_reader origin: URI::Generic?
|
|
|
|
# base_path
|
|
attr_reader base_path: String?
|
|
|
|
# ssl
|
|
|
|
# http2_settings
|
|
|
|
|
|
# classes
|
|
attr_reader connection_class: singleton(Connection)
|
|
|
|
attr_reader request_class: singleton(Request)
|
|
|
|
attr_reader response_class: singleton(Response)
|
|
|
|
attr_reader headers_class: singleton(Headers)
|
|
|
|
attr_reader request_body_class: singleton(Request::Body)
|
|
|
|
attr_reader response_body_class: singleton(Response::Body)
|
|
|
|
attr_reader resolver_class: Symbol | Class
|
|
|
|
attr_reader ssl: Hash[Symbol, untyped]
|
|
|
|
# io
|
|
type io_option = _ToIO | Hash[String, _ToIO]
|
|
attr_reader io: io_option?
|
|
|
|
# fallback_protocol
|
|
attr_reader fallback_protocol: String
|
|
|
|
# debug
|
|
attr_reader debug: _IOLogger?
|
|
|
|
# debug_level
|
|
attr_reader debug_level: Integer
|
|
|
|
# persistent
|
|
attr_reader persistent: bool
|
|
|
|
# resolver_options
|
|
attr_reader resolver_options: Hash[Symbol, untyped]
|
|
|
|
# ip_families
|
|
attr_reader ip_families: Array[ip_family]
|
|
|
|
def ==: (untyped other) -> bool
|
|
def merge: (_ToHash[Symbol, untyped] other) -> instance
|
|
def to_hash: () -> Hash[Symbol, untyped]
|
|
|
|
private
|
|
|
|
REQUEST_IVARS: Array[Symbol]
|
|
|
|
def initialize: (?options options) -> void
|
|
|
|
def do_initialize: (?options options) -> void
|
|
end
|
|
|
|
type options = Options | Hash[Symbol, untyped]
|
|
end
|