Package com.squareup.okhttp.internal.http

Class HttpConnection

java.lang.Object

com.squareup.okhttp.internal.http.HttpConnection

public final class HttpConnection
extends Object

A socket connection that can be used to send HTTP/1.1 messages. This class strictly enforces the following lifecycle:

1. Send request headers.
2. Open a sink to write the request body. Either fixed-length or chunked.
3. Write to and then close that sink.
4. Read response headers.
5. Open a source to read the response body. Either fixed-length, chunked or unknown length.
6. Read from and close that source.

Exchanges that do not have a request body may skip creating and closing the request body. Exchanges that do not have a response body can call newFixedLengthSource(0) and may skip reading and closing that source.

Constructor Summary

Constructors

Constructor	Description
HttpConnection(ConnectionPool pool, Connection connection, Socket socket)

Method Summary

Modifier and Type	Method	Description
long	bufferSize()	Returns the number of buffered bytes immediately readable.
void	closeIfOwnedBy(Object owner)
void	closeOnIdle()	Configure this connection to close itself when the HTTP response body is exhausted.
void	flush()
boolean	isClosed()	Returns true if this connection is closed.
boolean	isReadable()	Test for a stale socket.
Sink	newChunkedSink()
Source	newChunkedSource(HttpEngine httpEngine)
Sink	newFixedLengthSink(long contentLength)
Source	newFixedLengthSource(long length)
Source	newUnknownLengthSource()
void	poolOnIdle()	Configure this connection to put itself back into the connection pool when the HTTP response body is exhausted.
BufferedSink	rawSink()
BufferedSource	rawSource()
void	readHeaders(Headers.Builder builder)	Reads headers or trailers into builder.
Response.Builder	readResponse()	Parses bytes of a response header from an HTTP transport.
void	setTimeouts(int readTimeoutMillis, int writeTimeoutMillis)
void	writeRequest(Headers headers, String requestLine)	Returns bytes of a request header for sending on an HTTP transport.
void	writeRequestBody(RetryableSink requestBody)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpConnection

public HttpConnection(ConnectionPool pool,
                      Connection connection,
                      Socket socket)
               throws IOException

Throws:

IOException

Method Detail

setTimeouts

public void setTimeouts(int readTimeoutMillis,
                        int writeTimeoutMillis)

poolOnIdle

public void poolOnIdle()

Configure this connection to put itself back into the connection pool when the HTTP response body is exhausted.

closeOnIdle

public void closeOnIdle()
                 throws IOException

Configure this connection to close itself when the HTTP response body is exhausted.

Throws:

IOException

isClosed

public boolean isClosed()

Returns true if this connection is closed.

closeIfOwnedBy

public void closeIfOwnedBy(Object owner)
                    throws IOException

Throws:

IOException

flush

public void flush()
           throws IOException

Throws:

IOException

bufferSize

public long bufferSize()

Returns the number of buffered bytes immediately readable.

isReadable

public boolean isReadable()

Test for a stale socket.

writeRequest

public void writeRequest(Headers headers,
                         String requestLine)
                  throws IOException

Returns bytes of a request header for sending on an HTTP transport.

Throws:

IOException

readResponse

public Response.Builder readResponse()
                              throws IOException

Parses bytes of a response header from an HTTP transport.

Throws:

IOException

readHeaders

public void readHeaders(Headers.Builder builder)
                 throws IOException

Reads headers or trailers into builder.

Throws:

IOException

newChunkedSink

public Sink newChunkedSink()

newFixedLengthSink

public Sink newFixedLengthSink(long contentLength)

writeRequestBody

public void writeRequestBody(RetryableSink requestBody)
                      throws IOException

Throws:

IOException

newFixedLengthSource

public Source newFixedLengthSource(long length)
                            throws IOException

Throws:

IOException

newChunkedSource

public Source newChunkedSource(HttpEngine httpEngine)
                        throws IOException

Throws:

IOException

newUnknownLengthSource

public Source newUnknownLengthSource()
                              throws IOException

Throws:

IOException

rawSink

public BufferedSink rawSink()

rawSource

public BufferedSource rawSource()