okhttp3.internal.http1

Class Http1Codec

java.lang.Object

okhttp3.internal.http1.Http1Codec

All Implemented Interfaces:

HttpCodec

public final class Http1Codec
extends Object
implements HttpCodec

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.

Field Summary

Fields inherited from interface okhttp3.internal.http.HttpCodec

DISCARD_STREAM_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor and Description
Http1Codec(OkHttpClient client, StreamAllocation streamAllocation, okio.BufferedSource source, okio.BufferedSink sink)

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel this stream.
okio.Sink	createRequestBody(Request request, long contentLength) Returns an output stream where the request body can be streamed.
void	finishRequest() Flush the request to the underlying socket and signal no more bytes will be transmitted.
void	flushRequest() Flush the request to the underlying socket.
boolean	isClosed() Returns true if this connection is closed.
okio.Sink	newChunkedSink()
okio.Source	newChunkedSource(HttpUrl url)
okio.Sink	newFixedLengthSink(long contentLength)
okio.Source	newFixedLengthSource(long length)
okio.Source	newUnknownLengthSource()
ResponseBody	openResponseBody(Response response) Returns a stream that reads the response body.
Headers	readHeaders() Reads headers or trailers.
Response.Builder	readResponseHeaders(boolean expectContinue) Parses bytes of a response header from an HTTP transport.
void	writeRequest(Headers headers, String requestLine) Returns bytes of a request header for sending on an HTTP transport.
void	writeRequestHeaders(Request request) Prepares the HTTP headers and sends them to the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

Http1Codec

public Http1Codec(OkHttpClient client,
                  StreamAllocation streamAllocation,
                  okio.BufferedSource source,
                  okio.BufferedSink sink)

Method Detail

createRequestBody

public okio.Sink createRequestBody(Request request,
                                   long contentLength)

Description copied from interface: HttpCodec

Returns an output stream where the request body can be streamed.

Specified by:

createRequestBody in interface HttpCodec

cancel

public void cancel()

Description copied from interface: HttpCodec

Cancel this stream. Resources held by this stream will be cleaned up, though not synchronously. That may happen later by the connection pool thread.

Specified by:

cancel in interface HttpCodec

writeRequestHeaders

public void writeRequestHeaders(Request request)
                         throws IOException

Prepares the HTTP headers and sends them to the server.

For streaming requests with a body, headers must be prepared before the output stream has been written to. Otherwise the body would need to be buffered!

For non-streaming requests with a body, headers must be prepared after the output stream has been written to and closed. This ensures that the Content-Length header field receives the proper value.

Specified by:

writeRequestHeaders in interface HttpCodec

Throws:

IOException

openResponseBody

public ResponseBody openResponseBody(Response response)
                              throws IOException

Description copied from interface: HttpCodec

Returns a stream that reads the response body.

Specified by:

openResponseBody in interface HttpCodec

Throws:

IOException

isClosed

public boolean isClosed()

Returns true if this connection is closed.

flushRequest

public void flushRequest()
                  throws IOException

Description copied from interface: HttpCodec

Flush the request to the underlying socket.

Specified by:

flushRequest in interface HttpCodec

Throws:

IOException

finishRequest

public void finishRequest()
                   throws IOException

Description copied from interface: HttpCodec

Flush the request to the underlying socket and signal no more bytes will be transmitted.

Specified by:

finishRequest in interface HttpCodec

Throws:

IOException

writeRequest

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

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

Throws:

IOException

readResponseHeaders

public Response.Builder readResponseHeaders(boolean expectContinue)
                                     throws IOException

Description copied from interface: HttpCodec

Parses bytes of a response header from an HTTP transport.

Specified by:

readResponseHeaders in interface HttpCodec

Parameters:

expectContinue - true to return null if this is an intermediate response with a "100" response code. Otherwise this method never returns null.

Throws:

IOException

readHeaders

public Headers readHeaders()
                    throws IOException

Reads headers or trailers.

Throws:

IOException

newChunkedSink

public okio.Sink newChunkedSink()

newFixedLengthSink

public okio.Sink newFixedLengthSink(long contentLength)

newFixedLengthSource

public okio.Source newFixedLengthSource(long length)
                                 throws IOException

Throws:

IOException

newChunkedSource

public okio.Source newChunkedSource(HttpUrl url)
                             throws IOException

Throws:

IOException

newUnknownLengthSource

public okio.Source newUnknownLengthSource()
                                   throws IOException

Throws:

IOException