public class

ChunkedInputStream

extends InputStream
java.lang.Object
   ↳ java.io.InputStream
     ↳ org.apache.http.impl.io.ChunkedInputStream

Class Overview

Implements chunked transfer coding. The content is received in small chunks. Entities transferred using this input stream can be of unlimited length. After the stream is read to the end, it provides access to the trailers, if any.

Note that this class NEVER closes the underlying stream, even when close gets called. Instead, it will read until the "end" of its chunking on close, which allows for the seamless execution of subsequent HTTP 1.1 requests, while not requiring the client to remember to read the entire contents of the response.

Summary

Public Constructors
ChunkedInputStream(SessionInputBuffer in)
Wraps session input stream and reads chunk coded input.
Public Methods
int available()
void close()
Upon close, this reads the remainder of the chunked message, leaving the underlying socket at a position to start reading the next response without scanning.
Header[] getFooters()
int read(byte[] b)
Read some bytes from the stream.
int read()

Returns all the data in a chunked stream in coalesced form.

int read(byte[] b, int off, int len)
Read some bytes from the stream.
[Expand]
Inherited Methods
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable

Public Constructors

public ChunkedInputStream (SessionInputBuffer in)

Wraps session input stream and reads chunk coded input.

Parameters
in The session input buffer

Public Methods

public int available ()

Throws
IOException

public void close ()

Upon close, this reads the remainder of the chunked message, leaving the underlying socket at a position to start reading the next response without scanning.

Throws
IOException in case of an I/O error

public Header[] getFooters ()

public int read (byte[] b)

Read some bytes from the stream.

Parameters
b The byte array that will hold the contents from the stream.
Returns
  • The number of bytes returned or -1 if the end of stream has been reached.
Throws
IOException in case of an I/O error

public int read ()

Returns all the data in a chunked stream in coalesced form. A chunk is followed by a CRLF. The method returns -1 as soon as a chunksize of 0 is detected.

Trailer headers are read automatically at the end of the stream and can be obtained with the getResponseFooters() method.

Returns
  • -1 of the end of the stream has been reached or the next data byte
Throws
IOException in case of an I/O error

public int read (byte[] b, int off, int len)

Read some bytes from the stream.

Parameters
b The byte array that will hold the contents from the stream.
off The offset into the byte array at which bytes will start to be placed.
len the maximum number of bytes that can be returned.
Returns
  • The number of bytes returned or -1 if the end of stream has been reached.
Throws
IOException in case of an I/O error