Package org.apache.hc.core5.http.impl.io
Class ChunkedOutputStream
java.lang.Object
java.io.OutputStream
org.apache.hc.core5.http.impl.io.ChunkedOutputStream
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
Implements chunked transfer coding. The content is sent in small chunks.
Entities transferred using this output stream can be of unlimited length.
Writes are buffered to an internal buffer (2048 default size).
Note that this class NEVER closes the underlying stream, even when
close()
gets called. Instead, the stream will be marked as
closed and no further output will be permitted.
- Since:
- 4.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final SessionOutputBuffer
private final byte[]
private int
private boolean
private final CharArrayBuffer
private final OutputStream
private boolean
-
Constructor Summary
ConstructorsConstructorDescriptionChunkedOutputStream
(SessionOutputBuffer buffer, OutputStream outputStream, byte[] chunkCache, Supplier<List<? extends Header>> trailerSupplier) Default constructor.ChunkedOutputStream
(SessionOutputBuffer buffer, OutputStream outputStream, int chunkSizeHint) Constructor with no trailers.ChunkedOutputStream
(SessionOutputBuffer buffer, OutputStream outputStream, int chunkSizeHint, Supplier<List<? extends Header>> trailerSupplier) Constructor taking an integer chunk size hint. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Finishes writing to the underlying stream, but does NOT close the underlying stream.void
finish()
Must be called to ensure the internal cache is flushed and the closing chunk is written.void
flush()
Flushes the content buffer and the underlying stream.private void
Writes the cache out onto the underlying streamprivate void
flushCacheWithAppend
(byte[] bufferToAppend, int off, int len) Writes the cache and bufferToAppend to the underlying stream as one large chunkvoid
write
(byte[] b) Writes the array.void
write
(byte[] src, int off, int len) Writes the array.void
write
(int b) private void
private void
-
Field Details
-
buffer
-
outputStream
-
cache
private final byte[] cache -
cachePosition
private int cachePosition -
wroteLastChunk
private boolean wroteLastChunk -
closed
private boolean closed -
lineBuffer
-
trailerSupplier
-
-
Constructor Details
-
ChunkedOutputStream
public ChunkedOutputStream(SessionOutputBuffer buffer, OutputStream outputStream, byte[] chunkCache, Supplier<List<? extends Header>> trailerSupplier) Default constructor.- Parameters:
buffer
- Session output bufferoutputStream
- Output streamchunkCache
- Buffer used to aggregate smaller writes into chunks.trailerSupplier
- Trailer supplier. May benull
- Since:
- 5.1
-
ChunkedOutputStream
public ChunkedOutputStream(SessionOutputBuffer buffer, OutputStream outputStream, int chunkSizeHint, Supplier<List<? extends Header>> trailerSupplier) Constructor taking an integer chunk size hint.- Parameters:
buffer
- Session output bufferoutputStream
- Output streamchunkSizeHint
- minimal chunk size hinttrailerSupplier
- Trailer supplier. May benull
- Since:
- 5.0
-
ChunkedOutputStream
public ChunkedOutputStream(SessionOutputBuffer buffer, OutputStream outputStream, int chunkSizeHint) Constructor with no trailers.- Parameters:
buffer
- Session output bufferoutputStream
- Output streamchunkSizeHint
- minimal chunk size hint
-
-
Method Details
-
flushCache
Writes the cache out onto the underlying stream- Throws:
IOException
-
flushCacheWithAppend
Writes the cache and bufferToAppend to the underlying stream as one large chunk- Throws:
IOException
-
writeClosingChunk
- Throws:
IOException
-
writeTrailers
- Throws:
IOException
-
finish
Must be called to ensure the internal cache is flushed and the closing chunk is written.- Throws:
IOException
- in case of an I/O error
-
write
- Specified by:
write
in classOutputStream
- Throws:
IOException
-
write
Writes the array. If the array does not fit within the buffer, it is not split, but rather written out as one large chunk.- Overrides:
write
in classOutputStream
- Throws:
IOException
-
write
Writes the array. If the array does not fit within the buffer, it is not split, but rather written out as one large chunk.- Overrides:
write
in classOutputStream
- Throws:
IOException
-
flush
Flushes the content buffer and the underlying stream.- Specified by:
flush
in interfaceFlushable
- Overrides:
flush
in classOutputStream
- Throws:
IOException
-
close
Finishes writing to the underlying stream, but does NOT close the underlying stream.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classOutputStream
- Throws:
IOException
-