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, org.xnio.channels.CloseableChannel, org.xnio.channels.Configurable, org.xnio.channels.StreamSourceChannel, org.xnio.channels.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(org.xnio.channels.StreamSourceChannel delegate)

Method Summary

Methods

Modifier and Type	Method and Description
int	read(ByteBuffer dst)
long	read(ByteBuffer[] dsts)
long	read(ByteBuffer[] dsts, int offset, int length)
<T> T	setOption(org.xnio.Option<T> option, T value)
long	transferTo(long count, ByteBuffer throughBuffer, org.xnio.channels.StreamSinkChannel target)
long	transferTo(long position, long count, FileChannel target)

Methods inherited from class io.undertow.channels.DelegatingStreamSourceChannel

awaitReadable, awaitReadable, close, getCloseSetter, getIoThread, getOption, getReadSetter, getReadThread, getWorker, isOpen, isReadResumed, resumeReads, shutdownReads, 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(org.xnio.channels.StreamSourceChannel delegate)

Parameters:

delegate - The underlying channel

readTimeout - The read timeout, in milliseconds

Method Detail

transferTo

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

Specified by:

transferTo in interface org.xnio.channels.StreamSourceChannel

Overrides:

transferTo in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

Throws:

IOException

transferTo

public long transferTo(long count,
              ByteBuffer throughBuffer,
              org.xnio.channels.StreamSinkChannel target)
                throws IOException

Specified by:

transferTo in interface org.xnio.channels.StreamSourceChannel

Overrides:

transferTo in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

Throws:

IOException

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(org.xnio.Option<T> option,
              T value)
            throws IllegalArgumentException,
                   IOException

Specified by:

setOption in interface org.xnio.channels.Configurable

Overrides:

setOption in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>

Throws:

IllegalArgumentException

IOException