okhttp3.internal.http

Interface HttpCodec

All Known Implementing Classes:

Http1Codec, Http2Codec

public interface HttpCodec

Encodes HTTP requests and decodes HTTP responses.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISCARD_STREAM_TIMEOUT_MILLIS The timeout to use while discarding a stream of input data.

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.
ResponseBody	openResponseBody(Response response) Returns a stream that reads the response body.
Response.Builder	readResponseHeaders(boolean expectContinue) Parses bytes of a response header from an HTTP transport.
void	writeRequestHeaders(Request request) This should update the HTTP engine's sentRequestMillis field.

Field Detail

DISCARD_STREAM_TIMEOUT_MILLIS

static final int DISCARD_STREAM_TIMEOUT_MILLIS

The timeout to use while discarding a stream of input data. Since this is used for connection reuse, this timeout should be significantly less than the time it takes to establish a new connection.

See Also:

Constant Field Values

Method Detail

createRequestBody

okio.Sink createRequestBody(Request request,
                            long contentLength)

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

writeRequestHeaders

void writeRequestHeaders(Request request)
                  throws IOException

This should update the HTTP engine's sentRequestMillis field.

Throws:

IOException

flushRequest

void flushRequest()
           throws IOException

Flush the request to the underlying socket.

Throws:

IOException

finishRequest

void finishRequest()
            throws IOException

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

Throws:

IOException

readResponseHeaders

Response.Builder readResponseHeaders(boolean expectContinue)
                              throws IOException

Parses bytes of a response header from an HTTP transport.

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

openResponseBody

ResponseBody openResponseBody(Response response)
                       throws IOException

Returns a stream that reads the response body.

Throws:

IOException

cancel

void cancel()

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