com.squareup.okhttp

Class Route

java.lang.Object

com.squareup.okhttp.Route

public final class Route
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
Route(Address address, Proxy proxy, InetSocketAddress inetSocketAddress)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
Address	getAddress()
Proxy	getProxy() Returns the Proxy of this route.
InetSocketAddress	getSocketAddress()
int	hashCode() Returns an integer hash code for this object.
boolean	requiresTunnel() Returns true if this route tunnels HTTPS through an HTTP proxy.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Route

public Route(Address address,
             Proxy proxy,
             InetSocketAddress inetSocketAddress)

Method Detail

getAddress

public Address getAddress()

getProxy

public Proxy getProxy()

Returns the Proxy of this route. Warning: This may disagree with Address.getProxy() when it is null. When the address's proxy is null, the proxy selector is used.

getSocketAddress

public InetSocketAddress getSocketAddress()

requiresTunnel

public boolean requiresTunnel()

Returns true if this route tunnels HTTPS through an HTTP proxy. See RFC 2817, Section 5.2.

equals

public boolean equals(Object obj)

Description copied from class: Object

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this instance with.

Returns:

true if the specified object is equal to this Object; false otherwise.

See Also:

Object.hashCode()

hashCode

public int hashCode()

Description copied from class: Object

Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Overrides:

hashCode in class Object

Returns:

this object's hash code.

See Also:

Object.equals(java.lang.Object)