Route¶
[jvm]\ class Route(val address: Address, val proxy: Proxy, val socketAddress: InetSocketAddress)
The concrete route used by a connection to reach an abstract origin server. When creating a connection the client has many options:
- HTTP proxy: a proxy server may be explicitly configured for the client. Otherwise, the proxy selector is used. It may return multiple proxies to attempt.
- IP address: whether connecting directly to an origin server or a proxy, opening a socket requires an IP address. The DNS server may return multiple IP addresses to attempt.
Each route is a specific selection of these options.
Constructors¶
Route | [jvm] fun Route(address: Address, proxy: Proxy, socketAddress: InetSocketAddress) |
Functions¶
Name | Summary |
---|---|
equals | [jvm] open operator override fun equals(other: Any?): Boolean |
hashCode | [jvm] open override fun hashCode(): Int |
requiresTunnel | [jvm] fun requiresTunnel(): Boolean Returns true if this route tunnels HTTPS or HTTP/2 through an HTTP proxy. See RFC 2817, Section 5.2. |
toString | [jvm] open override fun toString(): String Returns a string with the URL hostname, socket IP address, and socket port, like one of these: |
Properties¶
Name | Summary |
---|---|
address | [jvm] @get:JvmName(name = "address") val address: Address |
proxy | [jvm] @get:JvmName(name = "proxy") val proxy: Proxy Returns the Proxy of this route. |
socketAddress | [jvm] @get:JvmName(name = "socketAddress") val socketAddress: InetSocketAddress |