Package org.apache.hc.core5.http.impl.io
Class ChunkedInputStream
java.lang.Object
java.io.InputStream
org.apache.hc.core5.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
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final SessionInputBuffer
The session input bufferprivate static final int
private long
The chunk sizeprivate boolean
True if this stream is closedprivate static final Header[]
private boolean
True if we've reached the end of streamprivate Header[]
private final Http1Config
private final InputStream
private final CharArrayBuffer
private long
The current position within the current chunkprivate ChunkedInputStream.State
-
Constructor Summary
ConstructorsConstructorDescriptionChunkedInputStream
(SessionInputBuffer buffer, InputStream inputStream) Wraps session input stream and reads chunk coded input.ChunkedInputStream
(SessionInputBuffer buffer, InputStream inputStream, Http1Config http1Config) Default constructor. -
Method Summary
Modifier and TypeMethodDescriptionint
void
close()
Reads the remainder of the chunked message, leaving the underlying stream 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
-
BUFFER_SIZE
private static final int BUFFER_SIZE- See Also:
-
EMPTY_FOOTERS
-
buffer
The session input buffer -
inputStream
-
lineBuffer
-
http1Config
-
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
public ChunkedInputStream(SessionInputBuffer buffer, InputStream inputStream, Http1Config http1Config) Default constructor.- Parameters:
buffer
- Session input bufferinputStream
- Input streamhttp1Config
- Message http1Config. Ifnull
Http1Config.DEFAULT
will be used.- Since:
- 4.4
-
ChunkedInputStream
Wraps session input stream and reads chunk coded input.- Parameters:
buffer
- Session input bufferinputStream
- Input stream
-
-
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
Reads the remainder of the chunked message, leaving the underlying stream at a position to start reading the next response without scanning. But does NOT close the underlying stream.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classInputStream
- Throws:
IOException
- in case of an I/O error
-