Package org.apache.coyote.http11.filters
Class ChunkedOutputFilter
java.lang.Object
org.apache.coyote.http11.filters.ChunkedOutputFilter
- All Implemented Interfaces:
HttpOutputBuffer,OutputFilter,OutputBuffer
Chunked output filter.
- Author:
- Remy Maucherat
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected HttpOutputBufferNext buffer in the pipeline.protected final ByteBufferChunk header.protected final ByteBufferEnd chunk. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintdoWrite(ByteBuffer chunk) Write the given data to the response.intDeprecated.Unused.voidend()Finish writing the current response.voidflush()Flushes any unwritten data to the client.longBytes written to the underlying socket.voidrecycle()Make the filter ready to process the next request.voidsetBuffer(HttpOutputBuffer buffer) Set the next buffer in the filter pipeline.voidsetResponse(Response response) Some filters need additional parameters from the response.
-
Field Details
-
buffer
Next buffer in the pipeline. -
chunkHeader
Chunk header. -
endChunk
End chunk.
-
-
Constructor Details
-
ChunkedOutputFilter
public ChunkedOutputFilter()Default constructor.
-
-
Method Details
-
doWrite
Deprecated.Unused. Will be removed in Tomcat 9. UsedoWrite(ByteBuffer)Description copied from interface:OutputBufferWrite the given data to the response. The caller owns the chunks.- Specified by:
doWritein interfaceOutputBuffer- Parameters:
chunk- data to write- Returns:
- The number of bytes written which may be less than available in the input chunk
- Throws:
IOException- an underlying I/O error occurred
-
doWrite
Description copied from interface:OutputBufferWrite the given data to the response. The caller owns the chunks.- Specified by:
doWritein interfaceOutputBuffer- Parameters:
chunk- data to write- Returns:
- The number of bytes written which may be less than available in the input chunk
- Throws:
IOException- an underlying I/O error occurred
-
getBytesWritten
public long getBytesWritten()Description copied from interface:OutputBufferBytes written to the underlying socket. This includes the effects of chunking, compression, etc.- Specified by:
getBytesWrittenin interfaceOutputBuffer- Returns:
- Bytes written for the current request
-
setResponse
Description copied from interface:OutputFilterSome filters need additional parameters from the response. All the necessary reading can occur in that method, as this method is called after the response header processing is complete.- Specified by:
setResponsein interfaceOutputFilter- Parameters:
response- The response to associate with this OutputFilter
-
setBuffer
Description copied from interface:OutputFilterSet the next buffer in the filter pipeline.- Specified by:
setBufferin interfaceOutputFilter- Parameters:
buffer- The next buffer instance
-
flush
Description copied from interface:HttpOutputBufferFlushes any unwritten data to the client.- Specified by:
flushin interfaceHttpOutputBuffer- Throws:
IOException- If an I/O error occurs while flushing
-
end
Description copied from interface:HttpOutputBufferFinish writing the current response. It is acceptable to write extra bytes usingOutputBuffer.doWrite(java.nio.ByteBuffer)during the execution of this method.- Specified by:
endin interfaceHttpOutputBuffer- Throws:
IOException- If an I/O error occurs while writing to the client
-
recycle
public void recycle()Description copied from interface:OutputFilterMake the filter ready to process the next request.- Specified by:
recyclein interfaceOutputFilter
-