Top Description Fields Constructors Methods
io.undertow.conduits

public Class ChunkedStreamSinkConduit

extends AbstractStreamSinkConduit<StreamSinkConduit>
Class Inheritance
Imports
java.io.IOException, .UnsupportedEncodingException, java.nio.ByteBuffer, java.nio.channels.ClosedChannelException, .FileChannel, java.nio.charset.StandardCharsets, java.util.concurrent.TimeUnit, java.util.function.Supplier, io.undertow.UndertowLogger, io.undertow.server.protocol.http.HttpAttachments, io.undertow.util.Attachable, .AttachmentKey, .HeaderMap, .HeaderValues, .Headers, .ImmediatePooledByteBuffer, org.xnio.IoUtils, io.undertow.connector.ByteBufferPool, .PooledByteBuffer, org.xnio.channels.StreamSourceChannel, org.xnio.conduits.AbstractStreamSinkConduit, .ConduitWritableByteChannel, .Conduits, .StreamSinkConduit
Channel that implements HTTP chunked transfer coding.
Author
Stuart Douglas

Field Summary

Modifier and TypeField and Description
private final Attachable
attachable

private final ByteBufferPool
bufferPool

private final ByteBuffer
chunkingBuffer

private final ByteBuffer
chunkingSepBuffer

private int
chunkleft

private static final int
CONF_FLAG_CONFIGURABLE

private static final int
CONF_FLAG_PASS_CLOSE

private final int
config

private static final byte[]
CRLF

"\r\n" as bytes in US ASCII encoding.

private static final byte[]
DIGITS

hexadecimal digits "0123456789abcdef" as bytes in US ASCII encoding.

private final ConduitListener<? super ChunkedStreamSinkConduit>
finishListener

private static final int
FLAG_FINISHED

private static final int
FLAG_FIRST_DATA_WRITTEN

private static final int
FLAG_NEXT_SHUTDOWN

private static final int
FLAG_WRITES_SHUTDOWN

Flag that is set when terminateWrites() or @{link #close()} is called

private static final int
FLAG_WRITTEN_FIRST_CHUNK

private static final byte[]
LAST_CHUNK

"0\r\n" as bytes in US ASCII encoding.

private PooledByteBuffer
lastChunkBuffer

private final HeaderMap
responseHeaders

private int
state

public static final AttachmentKey<HeaderMap>
TRAILERS

Deprecated
Trailers that are to be attached to the end of the HTTP response.

Constructor Summary

AccessConstructor and Description
public
ChunkedStreamSinkConduit(final StreamSinkConduit
the channel to wrap
next, final ByteBufferPool bufferPool, final boolean
true to allow configuration of the next channel, false otherwise
configurable, final boolean
true to close the underlying channel when this channel is closed, false otherwise
passClose, HeaderMap
The response headers
responseHeaders, final ConduitListener<? super ChunkedStreamSinkConduit>
The finish listener
finishListener, final Attachable
The attachable
attachable)

Construct a new instance.

Method Summary

Modifier and TypeMethod and Description
public void
awaitWritable()

Overrides org.xnio.conduits.AbstractSinkConduit.awaitWritable.

Implements org.xnio.conduits.SinkConduit.awaitWritable.

Block until this channel becomes writable again.

public void
awaitWritable(final long
the time to wait
time, final TimeUnit
the time unit
timeUnit)

Overrides org.xnio.conduits.AbstractSinkConduit.awaitWritable.

Implements org.xnio.conduits.SinkConduit.awaitWritable.

Block until this conduit becomes writable again, or until the timeout expires.

private void
createLastChunk(final boolean writeFinal)

pack-priv int
doWrite(final ByteBuffer src)

public boolean
flush()

Overrides org.xnio.conduits.AbstractSinkConduit.flush.

Implements org.xnio.conduits.SinkConduit.flush.

Flush out any unwritten, buffered output.

private void
invokeFinishListener()

private static void
putIntAsHexString(final ByteBuffer buf, final int v)

public void
terminateWrites()

Overrides org.xnio.conduits.AbstractSinkConduit.terminateWrites.

Implements org.xnio.conduits.SinkConduit.terminateWrites.

Signal that no more write data is forthcoming.

public long
transferFrom(final FileChannel
the file to read from
src, final long
the position within the file from which the transfer is to begin
position, final long
the number of bytes to be transferred
count)

Overrides org.xnio.conduits.AbstractStreamSinkConduit.transferFrom.

Implements org.xnio.conduits.StreamSinkConduit.transferFrom.

Transfer bytes into this conduit from the given file.

public long
transferFrom(final StreamSourceChannel
the source to read from
source, final long
the number of bytes to be transferred
count, final ByteBuffer
the buffer to copy through.
throughBuffer)

Overrides org.xnio.conduits.AbstractStreamSinkConduit.transferFrom.

Implements org.xnio.conduits.StreamSinkConduit.transferFrom.

Transfers bytes from the given channel source.

public void
truncateWrites()

Overrides org.xnio.conduits.AbstractSinkConduit.truncateWrites.

Implements org.xnio.conduits.SinkConduit.truncateWrites.

Terminate writes and discard any outstanding write data.

public int
write(final ByteBuffer
the buffer containing data to write
src)

Overrides org.xnio.conduits.AbstractStreamSinkConduit.write.

Implements org.xnio.conduits.StreamSinkConduit.write.

Writes a sequence of bytes to this conduit from the given buffer.

public long
write(final ByteBuffer[]
the buffers containing data to write
srcs, final int
the offset into the buffer array
offset, final int
the number of buffers to write
length)

Overrides org.xnio.conduits.AbstractStreamSinkConduit.write.

Implements org.xnio.conduits.StreamSinkConduit.write.

Writes a sequence of bytes to this conduit from the given buffers.

public long
writeFinal(ByteBuffer[]
The buffers from which bytes are to be retrieved
srcs, int
The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.length
offset, int
The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset
length)

Overrides org.xnio.conduits.AbstractStreamSinkConduit.writeFinal.

Implements org.xnio.conduits.StreamSinkConduit.writeFinal.

Writes some data to the conduit, with the same semantics as write(java.nio.ByteBuffer[], int, int).

public int
writeFinal(ByteBuffer
The data to write
src)

Overrides org.xnio.conduits.AbstractStreamSinkConduit.writeFinal.

Implements org.xnio.conduits.StreamSinkConduit.writeFinal.

Writes some data to the conduit, with the same semantics as write(java.nio.ByteBuffer).

Field Detail

attachableback to summary
private final Attachable attachable
bufferPoolback to summary
private final ByteBufferPool bufferPool
chunkingBufferback to summary
private final ByteBuffer chunkingBuffer
chunkingSepBufferback to summary
private final ByteBuffer chunkingSepBuffer
chunkleftback to summary
private int chunkleft
CONF_FLAG_CONFIGURABLEback to summary
private static final int CONF_FLAG_CONFIGURABLE
CONF_FLAG_PASS_CLOSEback to summary
private static final int CONF_FLAG_PASS_CLOSE
configback to summary
private final int config
CRLFback to summary
private static final byte[] CRLF

"\r\n" as bytes in US ASCII encoding.

DIGITSback to summary
private static final byte[] DIGITS

hexadecimal digits "0123456789abcdef" as bytes in US ASCII encoding.

finishListenerback to summary
private final ConduitListener<? super ChunkedStreamSinkConduit> finishListener
FLAG_FINISHEDback to summary
private static final int FLAG_FINISHED
FLAG_FIRST_DATA_WRITTENback to summary
private static final int FLAG_FIRST_DATA_WRITTEN
FLAG_NEXT_SHUTDOWNback to summary
private static final int FLAG_NEXT_SHUTDOWN
FLAG_WRITES_SHUTDOWNback to summary
private static final int FLAG_WRITES_SHUTDOWN

Flag that is set when terminateWrites() or @{link #close()} is called

FLAG_WRITTEN_FIRST_CHUNKback to summary
private static final int FLAG_WRITTEN_FIRST_CHUNK
LAST_CHUNKback to summary
private static final byte[] LAST_CHUNK

"0\r\n" as bytes in US ASCII encoding.

lastChunkBufferback to summary
private PooledByteBuffer lastChunkBuffer
responseHeadersback to summary
private final HeaderMap responseHeaders
stateback to summary
private int state
TRAILERSback to summary
public static final AttachmentKey<HeaderMap> TRAILERS

Deprecated

Trailers that are to be attached to the end of the HTTP response. Note that it is the callers responsibility to make sure the client understands trailers (i.e. they have provided a TE header), and to set the 'Trailers:' header appropriately.

This attachment must be set before the terminateWrites() method is called.

Annotations
@Deprecated

Constructor Detail

ChunkedStreamSinkConduitback to summary
public ChunkedStreamSinkConduit(final StreamSinkConduit next, final ByteBufferPool bufferPool, final boolean configurable, final boolean passClose, HeaderMap responseHeaders, final ConduitListener<? super ChunkedStreamSinkConduit> finishListener, final Attachable attachable)

Construct a new instance.

Parameters
next:StreamSinkConduit

the channel to wrap

configurable:boolean

true to allow configuration of the next channel, false otherwise

passClose:boolean

true to close the underlying channel when this channel is closed, false otherwise

responseHeaders:HeaderMap

The response headers

finishListener:ConduitListener<? super ChunkedStreamSinkConduit>

The finish listener

attachable:Attachable

The attachable

Method Detail

awaitWritableback to summary
public void awaitWritable() throws IOException

Overrides org.xnio.conduits.AbstractSinkConduit.awaitWritable.

Implements org.xnio.conduits.SinkConduit.awaitWritable.

Doc from org.xnio.conduits.SinkConduit.awaitWritable.

Block until this channel becomes writable again. This method may return spuriously before the channel becomes writable.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
awaitWritableback to summary
public void awaitWritable(final long time, final TimeUnit timeUnit) throws IOException

Overrides org.xnio.conduits.AbstractSinkConduit.awaitWritable.

Implements org.xnio.conduits.SinkConduit.awaitWritable.

Doc from org.xnio.conduits.SinkConduit.awaitWritable.

Block until this conduit becomes writable again, or until the timeout expires. This method may return spuriously before the conduit becomes writable or the timeout expires.

Parameters
time:long

the time to wait

timeUnit:TimeUnit

the time unit

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
createLastChunkback to summary
private void createLastChunk(final boolean writeFinal) throws UnsupportedEncodingException
doWriteback to summary
pack-priv int doWrite(final ByteBuffer src) throws IOException
flushback to summary
public boolean flush() throws IOException

Overrides org.xnio.conduits.AbstractSinkConduit.flush.

Implements org.xnio.conduits.SinkConduit.flush.

Doc from org.xnio.conduits.SinkConduit.flush.

Flush out any unwritten, buffered output.

Returns:boolean

true if everything is flushed, false otherwise

Annotations
@Override
Exceptions
IOException:
if flush fails
invokeFinishListenerback to summary
private void invokeFinishListener()
putIntAsHexStringback to summary
private static void putIntAsHexString(final ByteBuffer buf, final int v)
terminateWritesback to summary
public void terminateWrites() throws IOException

Overrides org.xnio.conduits.AbstractSinkConduit.terminateWrites.

Implements org.xnio.conduits.SinkConduit.terminateWrites.

Doc from org.xnio.conduits.SinkConduit.terminateWrites.

Signal that no more write data is forthcoming. The conduit must be flush()ed before it is considered to be shut down.

Annotations
@Override
transferFromback to summary
public long transferFrom(final FileChannel src, final long position, final long count) throws IOException

Overrides org.xnio.conduits.AbstractStreamSinkConduit.transferFrom.

Implements org.xnio.conduits.StreamSinkConduit.transferFrom.

Doc from org.xnio.conduits.StreamSinkConduit.transferFrom.

Transfer bytes into this conduit from the given file.

Parameters
src:FileChannel

the file to read from

position:long

the position within the file from which the transfer is to begin

count:long

the number of bytes to be transferred

Returns:long

the number of bytes (possibly 0) that were actually transferred

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
transferFromback to summary
public long transferFrom(final StreamSourceChannel source, final long count, final ByteBuffer throughBuffer) throws IOException

Overrides org.xnio.conduits.AbstractStreamSinkConduit.transferFrom.

Implements org.xnio.conduits.StreamSinkConduit.transferFrom.

Doc from org.xnio.conduits.StreamSinkConduit.transferFrom.

Transfers bytes from the given channel source. On entry, throughBuffer will be cleared. On exit, the buffer will be flipped for emptying, and may be empty or may contain data. If this method returns a value less than count, then the remaining data in throughBuffer may contain data read from source which must be written to this channel to complete the operation.

Parameters
source:StreamSourceChannel

the source to read from

count:long

the number of bytes to be transferred

throughBuffer:ByteBuffer

the buffer to copy through.

Returns:long

the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs
truncateWritesback to summary
public void truncateWrites() throws IOException

Overrides org.xnio.conduits.AbstractSinkConduit.truncateWrites.

Implements org.xnio.conduits.SinkConduit.truncateWrites.

Doc from org.xnio.conduits.SinkConduit.truncateWrites.

Terminate writes and discard any outstanding write data. The conduit is terminated and flushed regardless of the outcome of this method.

Annotations
@Override
Exceptions
IOException:
if channel termination failed for some reason
writeback to summary
public int write(final ByteBuffer src) throws IOException

Overrides org.xnio.conduits.AbstractStreamSinkConduit.write.

Implements org.xnio.conduits.StreamSinkConduit.write.

Doc from org.xnio.conduits.StreamSinkConduit.write.

Writes a sequence of bytes to this conduit from the given buffer.

Parameters
src:ByteBuffer

the buffer containing data to write

Returns:int

the number of bytes written, possibly 0

Annotations
@Override
Exceptions
IOException:
if an error occurs
writeback to summary
public long write(final ByteBuffer[] srcs, final int offset, final int length) throws IOException

Overrides org.xnio.conduits.AbstractStreamSinkConduit.write.

Implements org.xnio.conduits.StreamSinkConduit.write.

Doc from org.xnio.conduits.StreamSinkConduit.write.

Writes a sequence of bytes to this conduit from the given buffers.

Parameters
srcs:ByteBuffer[]

the buffers containing data to write

offset:int

the offset into the buffer array

length:int

the number of buffers to write

Returns:long

the number of bytes written, possibly 0

Annotations
@Override
Exceptions
IOException:
if an error occurs
writeFinalback to summary
public long writeFinal(ByteBuffer[] srcs, int offset, int length) throws IOException

Overrides org.xnio.conduits.AbstractStreamSinkConduit.writeFinal.

Implements org.xnio.conduits.StreamSinkConduit.writeFinal.

Doc from org.xnio.conduits.StreamSinkConduit.writeFinal.

Writes some data to the conduit, with the same semantics as write(java.nio.ByteBuffer[], int, int). If all the data is written out then the conduit will have its writes terminated.

Parameters
srcs:ByteBuffer[]

The buffers from which bytes are to be retrieved

offset:int

The offset within the buffer array of the first buffer from which bytes are to be retrieved; must be non-negative and no larger than srcs.length

length:int

The maximum number of buffers to be accessed; must be non-negative and no larger than srcs.length - offset

Returns:long

The amount of data that was actually written

Annotations
@Override
writeFinalback to summary
public int writeFinal(ByteBuffer src) throws IOException

Overrides org.xnio.conduits.AbstractStreamSinkConduit.writeFinal.

Implements org.xnio.conduits.StreamSinkConduit.writeFinal.

Doc from org.xnio.conduits.StreamSinkConduit.writeFinal.

Writes some data to the conduit, with the same semantics as write(java.nio.ByteBuffer). If all the data is written out then the conduit will have its writes terminated. Semantically this method is equivalent to: int rem = src.remaining(); int written = conduit.write(src); if(written == rem) { conduit.terminateWrites() }

Parameters
src:ByteBuffer

The data to write

Returns:int

The amount of data that was actually written.

Annotations
@Override