ReadTimeoutStreamSourceChannel (Undertow 1.3.0.CR1 API)

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)

Constructors
Constructor and Description
`ReadTimeoutStreamSourceChannel(org.xnio.channels.StreamSourceChannel delegate)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`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)`
`void`	`shutdownReads()`
`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, 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(org.xnio.channels.StreamSourceChannel delegate)
```
    Parameters:
    
    delegate - The underlying channel
- 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
  - shutdownReads
```
public void shutdownReads()
                   throws IOException
```
    Specified by:
    
    shutdownReads in interface org.xnio.channels.SuspendableReadChannel
    
    Overrides:
    
    shutdownReads in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    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 org.xnio.channels.CloseableChannel
    
    Overrides:
    
    close in class DelegatingStreamSourceChannel<ReadTimeoutStreamSourceChannel>
    
    Throws:
    
    IOException

Class ReadTimeoutStreamSourceChannel

Field Summary

Fields inherited from class io.undertow.channels.DelegatingStreamSourceChannel

Fields inherited from interface org.xnio.channels.Configurable

Constructor Summary

Method Summary

Methods inherited from class io.undertow.channels.DelegatingStreamSourceChannel

Methods inherited from class java.lang.Object

Constructor Detail

ReadTimeoutStreamSourceChannel

Method Detail

transferTo

transferTo

read

read

read

setOption

shutdownReads

close