io.undertow.conduits

Class ChunkedStreamSourceConduit

java.lang.Object

org.xnio.conduits.AbstractConduit<D>

org.xnio.conduits.AbstractSourceConduit<D>

org.xnio.conduits.AbstractStreamSourceConduit<StreamSourceConduit>

io.undertow.conduits.ChunkedStreamSourceConduit

All Implemented Interfaces:

Conduit, SourceConduit, StreamSourceConduit

public class ChunkedStreamSourceConduit
extends AbstractStreamSourceConduit<StreamSourceConduit>

Channel to de-chunkify data

Author:

Stuart Douglas

Field Summary

Fields

Modifier and Type	Field and Description
static AttachmentKey<HeaderMap>	TRAILERS Deprecated.

Fields inherited from class org.xnio.conduits.AbstractConduit

next

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChunkedStreamSourceConduit(StreamSourceConduit next, io.undertow.conduits.ChunkedStreamSourceConduit.BufferWrapper bufferWrapper, ConduitListener<? super ChunkedStreamSourceConduit> finishListener, Attachable attachable, HttpServerExchange exchange, Closeable closeable)
	ChunkedStreamSourceConduit(StreamSourceConduit next, HttpServerExchange exchange, ConduitListener<? super ChunkedStreamSourceConduit> finishListener)
	ChunkedStreamSourceConduit(StreamSourceConduit next, PushBackStreamSourceConduit channel, ByteBufferPool pool, ConduitListener<? super ChunkedStreamSourceConduit> finishListener, Attachable attachable, Closeable closeable)

Method Summary

Modifier and Type	Method and Description
boolean	isFinished()
int	read(ByteBuffer dst) Read a sequence of bytes from this conduit to the given buffer.
long	read(ByteBuffer[] dsts, int offset, int length) Read a sequence of bytes from this conduit to the given buffers.
void	terminateReads() Indicate that no more data will be read from this conduit.
long	transferTo(long count, ByteBuffer throughBuffer, StreamSinkChannel target) Transfers bytes into the given channel target.
long	transferTo(long position, long count, FileChannel target) Transfers bytes into the given file from this channel.

Methods inherited from class org.xnio.conduits.AbstractSourceConduit

awaitReadable, awaitReadable, getReadThread, isReadResumed, isReadShutdown, resumeReads, setReadReadyHandler, suspendReads, wakeupReads

Methods inherited from class org.xnio.conduits.AbstractConduit

getWorker

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xnio.conduits.SourceConduit

awaitReadable, awaitReadable, getReadThread, isReadResumed, isReadShutdown, resumeReads, setReadReadyHandler, suspendReads, wakeupReads

Methods inherited from interface org.xnio.conduits.Conduit

getWorker

Field Detail

TRAILERS

@Deprecated
public static final AttachmentKey<HeaderMap> TRAILERS

Deprecated.

If the response has HTTP footers they are attached to the exchange under this key. They will only be available once the exchange has been fully read.

Constructor Detail

ChunkedStreamSourceConduit

public ChunkedStreamSourceConduit(StreamSourceConduit next,
                                  PushBackStreamSourceConduit channel,
                                  ByteBufferPool pool,
                                  ConduitListener<? super ChunkedStreamSourceConduit> finishListener,
                                  Attachable attachable,
                                  Closeable closeable)

ChunkedStreamSourceConduit

public ChunkedStreamSourceConduit(StreamSourceConduit next,
                                  HttpServerExchange exchange,
                                  ConduitListener<? super ChunkedStreamSourceConduit> finishListener)

ChunkedStreamSourceConduit

protected ChunkedStreamSourceConduit(StreamSourceConduit next,
                                     io.undertow.conduits.ChunkedStreamSourceConduit.BufferWrapper bufferWrapper,
                                     ConduitListener<? super ChunkedStreamSourceConduit> finishListener,
                                     Attachable attachable,
                                     HttpServerExchange exchange,
                                     Closeable closeable)

Method Detail

transferTo

public long transferTo(long position,
                       long count,
                       FileChannel target)
                throws IOException

Description copied from interface: StreamSourceConduit

Transfers bytes into the given file from this channel.

Specified by:

transferTo in interface StreamSourceConduit

Overrides:

transferTo in class AbstractStreamSourceConduit<StreamSourceConduit>

Parameters:

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

count - the number of bytes to be transferred

target - the file to write to

Returns:

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

Throws:

IOException - if an I/O error occurs

transferTo

public long transferTo(long count,
                       ByteBuffer throughBuffer,
                       StreamSinkChannel target)
                throws IOException

Description copied from interface: StreamSourceConduit

Transfers bytes into the given channel target. On entry, throughBuffer will be cleared. On exit, the buffer will be flipped for emptying, and may possibly 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 this channel which must be written to target to complete the operation.

Specified by:

transferTo in interface StreamSourceConduit

Overrides:

transferTo in class AbstractStreamSourceConduit<StreamSourceConduit>

Parameters:

count - the number of bytes to be transferred

throughBuffer - the buffer to copy through.

target - the destination to write to

Returns:

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

Throws:

IOException - if an I/O error occurs

read

public long read(ByteBuffer[] dsts,
                 int offset,
                 int length)
          throws IOException

Description copied from interface: StreamSourceConduit

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

Specified by:

read in interface StreamSourceConduit

Overrides:

read in class AbstractStreamSourceConduit<StreamSourceConduit>

offset - the offset into the buffer array

length - the number of buffers to fill

Returns:

the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached or this conduit's SourceConduit.terminateReads() method was previously called

Throws:

IOException - if an error occurs

terminateReads

public void terminateReads()
                    throws IOException

Description copied from interface: SourceConduit

Indicate that no more data will be read from this conduit. If unread data exists, an exception may be thrown.

Specified by:

terminateReads in interface SourceConduit

Overrides:

terminateReads in class AbstractSourceConduit<StreamSourceConduit>

Throws:

IOException - if there was a problem

read

public int read(ByteBuffer dst)
         throws IOException

Description copied from interface: StreamSourceConduit

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

Specified by:

read in interface StreamSourceConduit

Overrides:

read in class AbstractStreamSourceConduit<StreamSourceConduit>

Returns:

the number of bytes (possibly 0) that were actually transferred, or -1 if the end of input was reached or this conduit's SourceConduit.terminateReads() method was previously called

Throws:

IOException - if an error occurs

isFinished

public boolean isFinished()