Top Description Fields Constructors Methods
io.undertow.conduits

public final Class FinishableStreamSourceConduit

extends AbstractStreamSourceConduit<StreamSourceConduit>
Class Inheritance
Imports
org.xnio.channels.StreamSinkChannel, org.xnio.conduits.AbstractStreamSourceConduit, .StreamSourceConduit, java.io.IOException, java.nio.ByteBuffer, java.nio.channels.FileChannel
A conduit that calls a finish listener when there is no data left in the underlying conduit.
Author
Stuart Douglas

Field Summary

Modifier and TypeField and Description
private boolean
finishCalled

private final ConduitListener<? super FinishableStreamSourceConduit>
finishListener

Constructor Summary

AccessConstructor and Description
public
FinishableStreamSourceConduit(final StreamSourceConduit next, final ConduitListener<? super FinishableStreamSourceConduit> finishListener)

Method Summary

Modifier and TypeMethod and Description
private void
exitRead(long
the number of bytes consumed by this call (may be 0)
consumed)

Exit a read method.

public long
read(final ByteBuffer[]
the buffers to fill with data from the conduit
dsts, final int
the offset into the buffer array
offset, final int
the number of buffers to fill
length)

Overrides org.xnio.conduits.AbstractStreamSourceConduit.read.

Implements org.xnio.conduits.StreamSourceConduit.read.

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

public int
read(final ByteBuffer
the buffer to fill with data from the conduit
dst)

Overrides org.xnio.conduits.AbstractStreamSourceConduit.read.

Implements org.xnio.conduits.StreamSourceConduit.read.

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

public long
transferTo(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, final FileChannel
the file to write to
target)

Overrides org.xnio.conduits.AbstractStreamSourceConduit.transferTo.

Implements org.xnio.conduits.StreamSourceConduit.transferTo.

Transfers bytes into the given file from this channel.

public long
transferTo(final long
the number of bytes to be transferred
count, final ByteBuffer
the buffer to copy through.
throughBuffer, final StreamSinkChannel
the destination to write to
target)

Overrides org.xnio.conduits.AbstractStreamSourceConduit.transferTo.

Implements org.xnio.conduits.StreamSourceConduit.transferTo.

Transfers bytes into the given channel target.

Field Detail

finishCalledback to summary
private boolean finishCalled
finishListenerback to summary
private final ConduitListener<? super FinishableStreamSourceConduit> finishListener

Constructor Detail

FinishableStreamSourceConduitback to summary
public FinishableStreamSourceConduit(final StreamSourceConduit next, final ConduitListener<? super FinishableStreamSourceConduit> finishListener)

Method Detail

exitReadback to summary
private void exitRead(long consumed)

Exit a read method.

Parameters
consumed:long

the number of bytes consumed by this call (may be 0)

readback to summary
public long read(final ByteBuffer[] dsts, final int offset, final int length) throws IOException

Overrides org.xnio.conduits.AbstractStreamSourceConduit.read.

Implements org.xnio.conduits.StreamSourceConduit.read.

Doc from org.xnio.conduits.StreamSourceConduit.read.

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

Parameters
dsts:ByteBuffer[]

the buffers to fill with data from the conduit

offset:int

the offset into the buffer array

length:int

the number of buffers to fill

Returns:long

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

Exceptions
IOException:
if an error occurs
readback to summary
public int read(final ByteBuffer dst) throws IOException

Overrides org.xnio.conduits.AbstractStreamSourceConduit.read.

Implements org.xnio.conduits.StreamSourceConduit.read.

Doc from org.xnio.conduits.StreamSourceConduit.read.

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

Parameters
dst:ByteBuffer

the buffer to fill with data from the conduit

Returns:int

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

Exceptions
IOException:
if an error occurs
transferToback to summary
public long transferTo(final long position, final long count, final FileChannel target) throws IOException

Overrides org.xnio.conduits.AbstractStreamSourceConduit.transferTo.

Implements org.xnio.conduits.StreamSourceConduit.transferTo.

Doc from org.xnio.conduits.StreamSourceConduit.transferTo.

Transfers bytes into the given file from this channel.

Parameters
position:long

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

count:long

the number of bytes to be transferred

target:FileChannel

the file to write to

Returns:long

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

Exceptions
IOException:
if an I/O error occurs
transferToback to summary
public long transferTo(final long count, final ByteBuffer throughBuffer, final StreamSinkChannel target) throws IOException

Overrides org.xnio.conduits.AbstractStreamSourceConduit.transferTo.

Implements org.xnio.conduits.StreamSourceConduit.transferTo.

Doc from org.xnio.conduits.StreamSourceConduit.transferTo.

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.

Parameters
count:long

the number of bytes to be transferred

throughBuffer:ByteBuffer

the buffer to copy through.

target:StreamSinkChannel

the destination to write to

Returns:long

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

Exceptions
IOException:
if an I/O error occurs