io.undertow.channels

Class ReadTimeoutStreamSourceChannel

java.lang.Object

io.undertow.channels.DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

io.undertow.channels.ReadTimeoutStreamSourceChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, CloseableChannel, Configurable, StreamSourceChannel, SuspendableReadChannel

public final class ReadTimeoutStreamSourceChannel
extends DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

Wrapper for read timeout. This should always be the first wrapper applied to the underlying channel.

Author:

Stuart Douglas

See Also:

Options.READ_TIMEOUT

Field Summary

Fields inherited from class io.undertow.channels.DelegatingStreamSourceChannel

closeSetter, delegate, readSetter

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Constructor and Description
ReadTimeoutStreamSourceChannel(StreamSourceChannel delegate)

Method Summary

Modifier and Type	Method and Description
void	close() Close this channel.
int	read(ByteBuffer dst)
long	read(ByteBuffer[] dsts)
long	read(ByteBuffer[] dsts, int offset, int length)
<T> T	setOption(Option<T> option, T value) Set an option for this channel.
void	shutdownReads() Places this readable channel at "end of stream".
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 io.undertow.channels.DelegatingStreamSourceChannel

awaitReadable, awaitReadable, getCloseSetter, getIoThread, getOption, getReadSetter, getReadThread, getWorker, isOpen, isReadResumed, resumeReads, supportsOption, suspendReads, wakeupReads

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadTimeoutStreamSourceChannel

public ReadTimeoutStreamSourceChannel(StreamSourceChannel delegate)

Parameters:

delegate - The underlying channel

Method Detail

transferTo

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

Description copied from interface: StreamSourceChannel

Transfers bytes into the given file from this channel. Using this method in preference to FileChannel.transferFrom(ReadableByteChannel, long, long) may provide a performance advantage on some platforms.

If the current thread is interrupted when this method is called, it may throw a InterruptedIOException; however, if this exception is thrown, the InterruptedIOException.bytesTransferred field is guaranteed to be 0.

Specified by:

transferTo in interface StreamSourceChannel

Overrides:

transferTo in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

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: StreamSourceChannel

Transfers bytes into the given channel target. On some platforms, this may avoid copying bytes between user and kernel space. On other platforms, bytes are passed through the throughBuffer parameter's buffer space. 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. Note that using a direct buffer may provide an intermediate performance gain on platforms without zero-copy facilities.

If the current thread is interrupted when this method is called, it may throw a InterruptedIOException; however, if this exception is thrown, the InterruptedIOException.bytesTransferred field is guaranteed to be 0. Note that the return value is the amount of data that was actually transferred to the StreamSinkChannel. The actual amount of data read could be larger than this, and can be calculated by adding the return value and the amount of data left in throughBuffer.

Specified by:

transferTo in interface StreamSourceChannel

Overrides:

transferTo in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

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

Specified by:

read in interface ScatteringByteChannel

Overrides:

read in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

Throws:

IOException

read

public long read(ByteBuffer[] dsts)
          throws IOException

Specified by:

read in interface ScatteringByteChannel

Overrides:

read in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

Throws:

IOException

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Overrides:

read in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

Throws:

IOException

setOption

public <T> T setOption(Option<T> option,
                       T value)
                throws IllegalArgumentException,
                       IOException

Description copied from interface: Configurable

Set an option for this channel. Unsupported options are ignored.

Specified by:

setOption in interface Configurable

Overrides:

setOption in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

Type Parameters:

T - the type of the option value

Parameters:

option - the option to set

value - the value of the option to set

Returns:

the previous option value, if any

Throws:

IllegalArgumentException - if the value is not acceptable for this option

IOException - if an I/O error occurred when modifying the option

shutdownReads

public void shutdownReads()
                   throws IOException

Description copied from interface: SuspendableReadChannel

Places this readable channel at "end of stream". Further reads will result in EOF. Shutting down all directions of a channel will cause CloseableChannel.close() to be called automatically.

Specified by:

shutdownReads in interface SuspendableReadChannel

Overrides:

shutdownReads in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

Throws:

IOException - if an I/O error occurs

close

public void close()
           throws IOException

Description copied from interface: CloseableChannel

Close this channel. When a channel is closed, its close listener is invoked. Invoking this method more than once has no additional effect.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface InterruptibleChannel

Specified by:

close in interface CloseableChannel

Overrides:

close in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

Throws:

IOException - if the close failed