Connection (OkHttp 1.6.0 API)

java.lang.Object
- com.squareup.okhttp.Connection

All Implemented Interfaces:

Closeable, AutoCloseable
```
public final class Connection
extends Object
implements Closeable
```
The sockets and streams of an HTTP, HTTPS, or HTTPS+SPDY connection. May be used for multiple HTTP request/response exchanges. Connections may be direct to the origin server or via a proxy.
Typically instances of this class are created, connected and exercised automatically by the HTTP client. Applications may use this class to monitor HTTP connections as members of a connection pool.
Do not confuse this class with the misnamed HttpURLConnection, which isn't so much a connection as a single request/response exchange.
Modern TLS
There are tradeoffs when selecting which options to include when negotiating a secure connection to a remote host. Newer TLS options are quite useful:
- Server Name Indication (SNI) enables one IP address to negotiate secure connections for multiple domain names.
- Next Protocol Negotiation (NPN) enables the HTTPS port (443) to be used for both HTTP and SPDY protocols.
Unfortunately, older HTTPS servers refuse to connect when such options are presented. Rather than avoiding these options entirely, this class allows a connection to be attempted with modern options and then retried without them should the attempt fail.

Constructor Summary

Constructors
Constructor and Description

Connection(ConnectionPool pool, Route route)

Constructors
Constructor and Description
`Connection(ConnectionPool pool, Route route)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`clearOwner()` Attempts to clears the owner of this connection.
`void`	`close()`
`void`	`closeIfOwnedBy(Object owner)` Closes this connection if it is currently owned by `owner`.
`void`	`connect(int connectTimeout, int readTimeout, TunnelRequest tunnelRequest)`
`Handshake`	`getHandshake()`
`int`	`getHttpMinorVersion()` Returns the minor HTTP version that should be used for future requests on this connection.
`long`	`getIdleStartTimeNs()` Returns the time in ns when this connection became idle.
`Object`	`getOwner()`
`Route`	`getRoute()` Returns the route used by this connection.
`Socket`	`getSocket()` Returns the socket that this connection uses, or null if the connection is not currently connected.
`void`	`incrementRecycleCount()`
`boolean`	`isAlive()` Returns true if this connection is alive.
`boolean`	`isConnected()` Returns true if `connect(int, int, com.squareup.okhttp.TunnelRequest)` has been attempted on this connection.
`boolean`	`isExpired(long keepAliveDurationNs)` Returns true if this connection has been idle for longer than `keepAliveDurationNs`.
`boolean`	`isIdle()` Returns true if this connection is idle.
`boolean`	`isReadable()` Returns true if we are confident that we can read data from this connection.
`boolean`	`isSpdy()` Returns true if this is a SPDY connection.
`Object`	`newTransport(com.squareup.okhttp.internal.http.HttpEngine httpEngine)` Returns the transport appropriate for this connection.
`int`	`recycleCount()` Returns the number of times this connection has been returned to the connection pool.
`boolean`	`requiresTunnel()` Returns true if the HTTP connection needs to tunnel one protocol over another, such as when using HTTPS through an HTTP proxy.
`void`	`resetIdleStartTime()`
`void`	`setHttpMinorVersion(int httpMinorVersion)`
`void`	`setOwner(Object owner)`
`void`	`updateReadTimeout(int newTimeout)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Connection
```
public Connection(ConnectionPool pool,
          Route route)
```
- Method Detail
  - getOwner
```
public Object getOwner()
```
  - setOwner
```
public void setOwner(Object owner)
```
  - clearOwner
```
public boolean clearOwner()
```
    Attempts to clears the owner of this connection. Returns true if the owner was cleared and the connection can be pooled or reused. This will return false if the connection cannot be pooled or reused, such as if it was closed with closeIfOwnedBy(java.lang.Object).
  - closeIfOwnedBy
```
public void closeIfOwnedBy(Object owner)
                    throws IOException
```
    Closes this connection if it is currently owned by owner. This also strips the ownership of the connection so it cannot be pooled or reused.
    
    Throws:
    
    IOException
  - connect
```
public void connect(int connectTimeout,
           int readTimeout,
           TunnelRequest tunnelRequest)
             throws IOException
```
    Throws:
    
    IOException
  - isConnected
```
public boolean isConnected()
```
    Returns true if connect(int, int, com.squareup.okhttp.TunnelRequest) has been attempted on this connection.
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException
  - getRoute
```
public Route getRoute()
```
    Returns the route used by this connection.
  - getSocket
```
public Socket getSocket()
```
    Returns the socket that this connection uses, or null if the connection is not currently connected.
  - isAlive
```
public boolean isAlive()
```
    Returns true if this connection is alive.
  - isReadable
```
public boolean isReadable()
```
    Returns true if we are confident that we can read data from this connection. This is more expensive and more accurate than isAlive(); callers should check isAlive() first.
  - resetIdleStartTime
```
public void resetIdleStartTime()
```
  - isIdle
```
public boolean isIdle()
```
    Returns true if this connection is idle.
  - isExpired
```
public boolean isExpired(long keepAliveDurationNs)
```
    Returns true if this connection has been idle for longer than keepAliveDurationNs.
  - getIdleStartTimeNs
```
public long getIdleStartTimeNs()
```
    Returns the time in ns when this connection became idle. Undefined if this connection is not idle.
  - getHandshake
```
public Handshake getHandshake()
```
  - newTransport
```
public Object newTransport(com.squareup.okhttp.internal.http.HttpEngine httpEngine)
                    throws IOException
```
    Returns the transport appropriate for this connection.
    
    Throws:
    
    IOException
  - isSpdy
```
public boolean isSpdy()
```
    Returns true if this is a SPDY connection. Such connections can be used in multiple HTTP requests simultaneously.
  - getHttpMinorVersion
```
public int getHttpMinorVersion()
```
    Returns the minor HTTP version that should be used for future requests on this connection. Either 0 for HTTP/1.0, or 1 for HTTP/1.1. The default value is 1 for new connections.
  - setHttpMinorVersion
```
public void setHttpMinorVersion(int httpMinorVersion)
```
  - requiresTunnel
```
public boolean requiresTunnel()
```
    Returns true if the HTTP connection needs to tunnel one protocol over another, such as when using HTTPS through an HTTP proxy. When doing so, we must avoid buffering bytes intended for the higher-level protocol.
  - updateReadTimeout
```
public void updateReadTimeout(int newTimeout)
                       throws IOException
```
    Throws:
    
    IOException
  - incrementRecycleCount
```
public void incrementRecycleCount()
```
  - recycleCount
```
public int recycleCount()
```
    Returns the number of times this connection has been returned to the connection pool.

Class Connection

Modern TLS

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Connection

Method Detail

getOwner

setOwner

clearOwner

closeIfOwnedBy

connect

isConnected

close

getRoute

getSocket

isAlive

isReadable

resetIdleStartTime

isIdle

isExpired

getIdleStartTimeNs

getHandshake

newTransport

isSpdy

getHttpMinorVersion

setHttpMinorVersion

requiresTunnel

updateReadTimeout

incrementRecycleCount

recycleCount