Package org.apache.http.impl.io
Class ChunkedInputStream
java.lang.Object
java.io.InputStream
org.apache.http.impl.io.ChunkedInputStream
- All Implemented Interfaces:
Closeable
,AutoCloseable
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.
- Since:
- 4.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final CharArrayBuffer
private static final int
private static final int
private static final int
private static final int
private static final int
private long
The chunk sizeprivate boolean
True if this stream is closedprivate final MessageConstraints
private boolean
True if we've reached the end of streamprivate Header[]
private final SessionInputBuffer
The session input bufferprivate long
The current position within the current chunkprivate int
-
Constructor Summary
ConstructorsConstructorDescriptionWraps session input stream and reads chunk coded input.ChunkedInputStream
(SessionInputBuffer in, MessageConstraints constraints) Wraps session input stream and reads chunk coded input. -
Method Summary
Modifier and TypeMethodDescriptionint
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.private long
Expects the stream to start with a chunksize in hex with optional comments after a semicolon.Header[]
private void
Read the next chunk.private void
Reads and stores the Trailer headers.int
read()
Returns all the data in a chunked stream in coalesced form.int
read
(byte[] b) Read some bytes from the stream.int
read
(byte[] b, int off, int len) Read some bytes from the stream.Methods inherited from class java.io.InputStream
mark, markSupported, reset, skip
-
Field Details
-
CHUNK_LEN
private static final int CHUNK_LEN- See Also:
-
CHUNK_DATA
private static final int CHUNK_DATA- See Also:
-
CHUNK_CRLF
private static final int CHUNK_CRLF- See Also:
-
CHUNK_INVALID
private static final int CHUNK_INVALID- See Also:
-
BUFFER_SIZE
private static final int BUFFER_SIZE- See Also:
-
in
The session input buffer -
buffer
-
constraints
-
state
private int state -
chunkSize
private long chunkSizeThe chunk size -
pos
private long posThe current position within the current chunk -
eof
private boolean eofTrue if we've reached the end of stream -
closed
private boolean closedTrue if this stream is closed
-
-
Constructor Details
-
ChunkedInputStream
Wraps session input stream and reads chunk coded input.- Parameters:
in
- The session input bufferconstraints
- Message constraints. Ifnull
MessageConstraints.DEFAULT
will be used.- Since:
- 4.4
-
ChunkedInputStream
Wraps session input stream and reads chunk coded input.- Parameters:
in
- The session input buffer
-
-
Method Details
-
available
- Overrides:
available
in classInputStream
- Throws:
IOException
-
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.
- Specified by:
read
in classInputStream
- 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
-
read
Read some bytes from the stream.- Overrides:
read
in classInputStream
- 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
-
read
Read some bytes from the stream.- Overrides:
read
in classInputStream
- 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
-
nextChunk
Read the next chunk.- Throws:
IOException
- in case of an I/O error
-
getChunkSize
Expects the stream to start with a chunksize in hex with optional comments after a semicolon. The line must end with a CRLF: "a3; some comment\r\n" Positions the stream at the start of the next line.- Throws:
IOException
-
parseTrailerHeaders
Reads and stores the Trailer headers.- Throws:
IOException
- in case of an I/O error
-
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.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
- in case of an I/O error
-