io.undertow.conduits

Class FixedLengthStreamSourceConduit

java.lang.Object

org.xnio.conduits.AbstractConduit<D>

org.xnio.conduits.AbstractSourceConduit<D>

org.xnio.conduits.AbstractStreamSourceConduit<StreamSourceConduit>

io.undertow.conduits.FixedLengthStreamSourceConduit

All Implemented Interfaces:

Conduit, SourceConduit, StreamSourceConduit

public final class FixedLengthStreamSourceConduit
extends AbstractStreamSourceConduit<StreamSourceConduit>

A channel which reads data of a fixed length and calls a finish listener. When the finish listener is called, it should examine the result of getRemaining() to see if more bytes were pending when the channel was closed.

Author:

David M. Lloyd

Field Summary

Fields inherited from class org.xnio.conduits.AbstractConduit

next

Constructor Summary

Constructors

Constructor and Description
FixedLengthStreamSourceConduit(StreamSourceConduit next, long contentLength, ConduitListener<? super FixedLengthStreamSourceConduit> finishListener) Construct a new instance.
FixedLengthStreamSourceConduit(StreamSourceConduit next, long contentLength, ConduitListener<? super FixedLengthStreamSourceConduit> finishListener, HttpServerExchange exchange) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	awaitReadable() Block until this channel becomes readable again.
void	awaitReadable(long time, TimeUnit timeUnit) Block until this conduit becomes readable again, or until the timeout expires.
long	getRemaining() Get the number of remaining bytes.
boolean	isReadResumed() Determine whether read notifications are currently enabled.
int	read(ByteBuffer dst) Read a sequence of bytes from this conduit to the given buffer.
long	read(ByteBuffer[] dsts)
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.
void	wakeupReads() Indicate that the conduit's ReadReadyHandler should be invoked immediately, and then again as soon as data can be read without blocking.

Methods inherited from class org.xnio.conduits.AbstractSourceConduit

getReadThread, isReadShutdown, resumeReads, setReadReadyHandler, suspendReads

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

getReadThread, isReadShutdown, resumeReads, setReadReadyHandler, suspendReads

Methods inherited from interface org.xnio.conduits.Conduit

getWorker

Constructor Detail

FixedLengthStreamSourceConduit

public FixedLengthStreamSourceConduit(StreamSourceConduit next,
                                      long contentLength,
                                      ConduitListener<? super FixedLengthStreamSourceConduit> finishListener,
                                      HttpServerExchange exchange)

Construct a new instance. The given listener is called once all the bytes are read from the stream or the stream is closed. This listener should cause the remaining data to be drained from the underlying stream if the underlying stream is to be reused.

Calling this constructor will replace the read listener of the underlying channel. The listener should be restored from the finishListener object. The underlying stream should not be closed while this wrapper stream is active.

Parameters:

next - the stream source channel to read from

contentLength - the amount of content to read

finishListener - the listener to call once the stream is exhausted or closed

exchange - The server exchange. This is used to determine the max size

FixedLengthStreamSourceConduit

public FixedLengthStreamSourceConduit(StreamSourceConduit next,
                                      long contentLength,
                                      ConduitListener<? super FixedLengthStreamSourceConduit> finishListener)

Construct a new instance. The given listener is called once all the bytes are read from the stream or the stream is closed. This listener should cause the remaining data to be drained from the underlying stream if the underlying stream is to be reused.

Calling this constructor will replace the read listener of the underlying channel. The listener should be restored from the finishListener object. The underlying stream should not be closed while this wrapper stream is active.

Parameters:

next - the stream source channel to read from

contentLength - the amount of content to read

finishListener - the listener to call once the stream is exhausted or closed

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

read

public long read(ByteBuffer[] dsts)
          throws IOException

Throws:

IOException

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

isReadResumed

public boolean isReadResumed()

Description copied from interface: SourceConduit

Determine whether read notifications are currently enabled.

Specified by:

isReadResumed in interface SourceConduit

Overrides:

isReadResumed in class AbstractSourceConduit<StreamSourceConduit>

Returns:

true if read notifications are enabled

wakeupReads

public void wakeupReads()

Description copied from interface: SourceConduit

Indicate that the conduit's ReadReadyHandler should be invoked immediately, and then again as soon as data can be read without blocking.

Specified by:

wakeupReads in interface SourceConduit

Overrides:

wakeupReads in class AbstractSourceConduit<StreamSourceConduit>

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

awaitReadable

public void awaitReadable()
                   throws IOException

Description copied from interface: SourceConduit

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

Specified by:

awaitReadable in interface SourceConduit

Overrides:

awaitReadable in class AbstractSourceConduit<StreamSourceConduit>

Throws:

InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well

IOException - if an I/O error occurs

awaitReadable

public void awaitReadable(long time,
                          TimeUnit timeUnit)
                   throws IOException

Description copied from interface: SourceConduit

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

Specified by:

awaitReadable in interface SourceConduit

Overrides:

awaitReadable in class AbstractSourceConduit<StreamSourceConduit>

Parameters:

time - the time to wait

timeUnit - the time unit

Throws:

InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well

IOException - if an I/O error occurs

getRemaining

public long getRemaining()

Get the number of remaining bytes.

Returns:

the number of remaining bytes