okhttp/okhttp3/Address

Address

class Address(uriHost: String, uriPort: Int, val dns: Dns, val socketFactory: SocketFactory, val sslSocketFactory: SSLSocketFactory?, val hostnameVerifier: HostnameVerifier?, val certificatePinner: CertificatePinner?, val proxyAuthenticator: Authenticator, val proxy: Proxy?, protocols: List<Protocol>, connectionSpecs: List<ConnectionSpec>, val 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.

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

Constructors

Address

constructor(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)

Properties

certificatePinner

@get:JvmName(name = "certificatePinner")

val certificatePinner: CertificatePinner?

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

connectionSpecs

@get:JvmName(name = "connectionSpecs")

val connectionSpecs: List<ConnectionSpec>

dns

@get:JvmName(name = "dns")

val dns: Dns

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

hostnameVerifier

@get:JvmName(name = "hostnameVerifier")

val hostnameVerifier: HostnameVerifier?

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

protocols

@get:JvmName(name = "protocols")

val protocols: List<Protocol>

The protocols the client supports. This method always returns a non-null list that contains minimally Protocol.HTTP_1_1.

proxy

@get:JvmName(name = "proxy")

val proxy: Proxy?

Returns this address's explicitly-specified HTTP proxy, or null to delegate to the proxy selector.

proxyAuthenticator

@get:JvmName(name = "proxyAuthenticator")

val proxyAuthenticator: Authenticator

Returns the client's proxy authenticator.

proxySelector

@get:JvmName(name = "proxySelector")

val 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

@get:JvmName(name = "socketFactory")

val socketFactory: SocketFactory

Returns the socket factory for new connections.

sslSocketFactory

@get:JvmName(name = "sslSocketFactory")

val sslSocketFactory: SSLSocketFactory?

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

url

@get:JvmName(name = "url")

val 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.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String