okhttp / okhttp3 / Address

Address

class Address

A specification for a connection to an origin server. For simple connections, this is the server's hostname and port. If an explicit proxy is requested (or no proxy is explicitly requested), this also includes that proxy information. For secure connections the address also includes the SSL socket factory, hostname verifier, and certificate pinner.

HTTP requests that share the same Address may also share the same Connection.

Constructors

<init>

Address(uriHost: String, uriPort: Int, dns: Dns, socketFactory: SocketFactory, sslSocketFactory: SSLSocketFactory?, hostnameVerifier: HostnameVerifier?, certificatePinner: CertificatePinner?, proxyAuthenticator: Authenticator, proxy: Proxy?, protocols: List<Protocol>, connectionSpecs: List<ConnectionSpec>, proxySelector: ProxySelector)

A specification for a connection to an origin server. For simple connections, this is the server's hostname and port. If an explicit proxy is requested (or no proxy is explicitly requested), this also includes that proxy information. For secure connections the address also includes the SSL socket factory, hostname verifier, and certificate pinner.

Functions

certificatePinner

fun certificatePinner(): CertificatePinner?

Returns this address's certificate pinner, or null if this is not an HTTPS address.

connectionSpecs

fun connectionSpecs(): List<ConnectionSpec>

dns

fun dns(): Dns

Returns the service that will be used to resolve IP addresses for hostnames.

equals

fun equals(other: Any?): Boolean

hashCode

fun hashCode(): Int

hostnameVerifier

fun hostnameVerifier(): HostnameVerifier?

Returns the hostname verifier, or null if this is not an HTTPS address.

protocols

fun protocols(): List<Protocol>

Returns the protocols the client supports. This method always returns a non-null list that contains minimally {@link Protocol#HTTP_1_1}.

proxy

fun proxy(): Proxy?

Returns this address's explicitly-specified HTTP proxy, or null to delegate to the {@linkplain #proxySelector proxy selector}.

proxyAuthenticator

fun proxyAuthenticator(): Authenticator

Returns the client's proxy authenticator.

proxySelector

fun proxySelector(): ProxySelector

Returns this address's proxy selector. Only used if the proxy is null. If none of this selector's proxies are reachable, a direct connection will be attempted.

socketFactory

fun socketFactory(): SocketFactory

Returns the socket factory for new connections.

sslSocketFactory

fun sslSocketFactory(): SSLSocketFactory?

Returns the SSL socket factory, or null if this is not an HTTPS address.

toString

fun toString(): String

url

fun url(): HttpUrl

Returns a URL with the hostname and port of the origin server. The path, query, and fragment of this URL are always empty, since they are not significant for planning a route.