Http1xStream (OkHttp (Parent) 2.7.4 API)

java.lang.Object
- com.squareup.okhttp.internal.http.Http1xStream

All Implemented Interfaces:

HttpStream
```
public final class Http1xStream
extends Object
implements HttpStream
```
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 com.squareup.okhttp.internal.http.HttpStream
  DISCARD_STREAM_TIMEOUT_MILLIS

Constructor Summary

Constructors
Constructor and Description

Http1xStream(StreamAllocation streamAllocation, okio.BufferedSource source, okio.BufferedSink sink)

Constructors
Constructor and Description
`Http1xStream(StreamAllocation streamAllocation, okio.BufferedSource source, okio.BufferedSink sink)`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`boolean`	`isClosed()` Returns true if this connection is closed.
`okio.Sink`	`newChunkedSink()`
`okio.Source`	`newChunkedSource(HttpEngine httpEngine)`
`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`	`readResponse()` Parses bytes of a response header from an HTTP transport.
`Response.Builder`	`readResponseHeaders()` Read and return response headers.
`void`	`setHttpEngine(HttpEngine httpEngine)`
`void`	`writeRequest(Headers headers, String requestLine)` Returns bytes of a request header for sending on an HTTP transport.
`void`	`writeRequestBody(RetryableSink requestBody)` Sends the request body returned by `HttpStream.createRequestBody(com.squareup.okhttp.Request, long)` to the remote peer.
`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
  - Http1xStream
```
public Http1xStream(StreamAllocation streamAllocation,
                    okio.BufferedSource source,
                    okio.BufferedSink sink)
```
- Method Detail
  - setHttpEngine
```
public void setHttpEngine(HttpEngine httpEngine)
```
    Specified by:
    
    setHttpEngine in interface HttpStream
  - createRequestBody
```
public okio.Sink createRequestBody(Request request,
                                   long contentLength)
                            throws IOException
```
    Description copied from interface: HttpStream
    
    Returns an output stream where the request body can be streamed.
    
    Specified by:
    
    createRequestBody in interface HttpStream
    
    Throws:
    
    IOException
  - cancel
```
public void cancel()
```
    Description copied from interface: HttpStream
    
    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 HttpStream
  - 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 HttpStream
    
    Throws:
    
    IOException
  - readResponseHeaders
```
public Response.Builder readResponseHeaders()
                                     throws IOException
```
    Description copied from interface: HttpStream
    
    Read and return response headers.
    
    Specified by:
    
    readResponseHeaders in interface HttpStream
    
    Throws:
    
    IOException
  - openResponseBody
```
public ResponseBody openResponseBody(Response response)
                              throws IOException
```
    Description copied from interface: HttpStream
    
    Returns a stream that reads the response body.
    
    Specified by:
    
    openResponseBody in interface HttpStream
    
    Throws:
    
    IOException
  - isClosed
```
public boolean isClosed()
```
    Returns true if this connection is closed.
  - finishRequest
```
public void finishRequest()
                   throws IOException
```
    Description copied from interface: HttpStream
    
    Flush the request to the underlying socket.
    
    Specified by:
    
    finishRequest in interface HttpStream
    
    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
  - readResponse
```
public Response.Builder readResponse()
                              throws IOException
```
    Parses bytes of a response header from an HTTP transport.
    
    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)
```
  - writeRequestBody
```
public void writeRequestBody(RetryableSink requestBody)
                      throws IOException
```
    Description copied from interface: HttpStream
    
    Sends the request body returned by HttpStream.createRequestBody(com.squareup.okhttp.Request, long) to the remote peer.
    
    Specified by:
    
    writeRequestBody in interface HttpStream
    
    Throws:
    
    IOException
  - newFixedLengthSource
```
public okio.Source newFixedLengthSource(long length)
                                 throws IOException
```
    Throws:
    
    IOException
  - newChunkedSource
```
public okio.Source newChunkedSource(HttpEngine httpEngine)
                             throws IOException
```
    Throws:
    
    IOException
  - newUnknownLengthSource
```
public okio.Source newUnknownLengthSource()
                                   throws IOException
```
    Throws:
    
    IOException

Class Http1xStream

Field Summary

Fields inherited from interface com.squareup.okhttp.internal.http.HttpStream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Http1xStream

Method Detail

setHttpEngine

createRequestBody

cancel

writeRequestHeaders

readResponseHeaders

openResponseBody

isClosed

finishRequest

writeRequest

readResponse

readHeaders

newChunkedSink

newFixedLengthSink

writeRequestBody

newFixedLengthSource

newChunkedSource

newUnknownLengthSource