okhttp / okhttp3 / Route

Route

class Route

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

Name Summary
<init> The concrete route used by a connection to reach an abstract origin server. When creating a connection the client has many options:Route(address:Address, proxy:Proxy, socketAddress:InetSocketAddress)

Properties

Name Summary
address val address:Address
proxy Returns the Proxy of this route.val proxy:Proxy
socketAddress val socketAddress:InetSocketAddress

Functions

Name Summary
equals fun equals(other:Any?):Boolean
hashCode fun hashCode():Int
requiresTunnel Returns true if this route tunnels HTTPS through an HTTP proxy. See RFC 2817, Section 5.2.fun requiresTunnel():Boolean
toString fun toString():String