ChannelFunctionStreamSourceChannel (Undertow 1.4.13.Final-SNAPSHOT API)

java.lang.Object
- io.undertow.websockets.core.function.ChannelFunctionStreamSourceChannel

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 class ChannelFunctionStreamSourceChannel
extends Object
implements org.xnio.channels.StreamSourceChannel
```
Author:

Norman Maurer

Field Summary
- Fields inherited from interface org.xnio.channels.Configurable
  EMPTY

Constructor Summary

Constructors
Constructor and Description

ChannelFunctionStreamSourceChannel(org.xnio.channels.StreamSourceChannel channel, ChannelFunction... functions)

Constructors
Constructor and Description
`ChannelFunctionStreamSourceChannel(org.xnio.channels.StreamSourceChannel channel, ChannelFunction... functions)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`awaitReadable()`
`void`	`awaitReadable(long time, TimeUnit timeUnit)`
`void`	`close()`
`org.xnio.ChannelListener.Setter<? extends org.xnio.channels.StreamSourceChannel>`	`getCloseSetter()`
`org.xnio.XnioIoThread`	`getIoThread()`
`<T> T`	`getOption(org.xnio.Option<T> option)`
`org.xnio.ChannelListener.Setter<? extends org.xnio.channels.StreamSourceChannel>`	`getReadSetter()`
`org.xnio.XnioExecutor`	`getReadThread()`
`org.xnio.XnioWorker`	`getWorker()`
`boolean`	`isOpen()`
`boolean`	`isReadResumed()`
`int`	`read(ByteBuffer dst)`
`long`	`read(ByteBuffer[] dsts)`
`long`	`read(ByteBuffer[] dsts, int offset, int length)`
`void`	`resumeReads()`
`<T> T`	`setOption(org.xnio.Option<T> option, T value)`
`void`	`shutdownReads()`
`boolean`	`supportsOption(org.xnio.Option<?> option)`
`void`	`suspendReads()`
`long`	`transferTo(long count, ByteBuffer throughBuffer, org.xnio.channels.StreamSinkChannel target)`
`long`	`transferTo(long position, long count, FileChannel target)`
`void`	`wakeupReads()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ChannelFunctionStreamSourceChannel
```
public ChannelFunctionStreamSourceChannel(org.xnio.channels.StreamSourceChannel channel,
                                          ChannelFunction... functions)
```
- Method Detail
  - transferTo
```
public long transferTo(long position,
                       long count,
                       FileChannel target)
                throws IOException
```
    Specified by:
    
    transferTo in interface org.xnio.channels.StreamSourceChannel
    
    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
    
    Throws:
    
    IOException
  - getReadSetter
```
public org.xnio.ChannelListener.Setter<? extends org.xnio.channels.StreamSourceChannel> getReadSetter()
```
    Specified by:
    
    getReadSetter in interface org.xnio.channels.StreamSourceChannel
    
    Specified by:
    
    getReadSetter in interface org.xnio.channels.SuspendableReadChannel
  - getCloseSetter
```
public org.xnio.ChannelListener.Setter<? extends org.xnio.channels.StreamSourceChannel> getCloseSetter()
```
    Specified by:
    
    getCloseSetter in interface org.xnio.channels.CloseableChannel
    
    Specified by:
    
    getCloseSetter in interface org.xnio.channels.StreamSourceChannel
    
    Specified by:
    
    getCloseSetter in interface org.xnio.channels.SuspendableReadChannel
  - read
```
public long read(ByteBuffer[] dsts,
                 int offset,
                 int length)
          throws IOException
```
    Specified by:
    
    read in interface ScatteringByteChannel
    
    Throws:
    
    IOException
  - read
```
public long read(ByteBuffer[] dsts)
          throws IOException
```
    Specified by:
    
    read in interface ScatteringByteChannel
    
    Throws:
    
    IOException
  - suspendReads
```
public void suspendReads()
```
    Specified by:
    
    suspendReads in interface org.xnio.channels.SuspendableReadChannel
  - resumeReads
```
public void resumeReads()
```
    Specified by:
    
    resumeReads in interface org.xnio.channels.SuspendableReadChannel
  - isReadResumed
```
public boolean isReadResumed()
```
    Specified by:
    
    isReadResumed in interface org.xnio.channels.SuspendableReadChannel
  - wakeupReads
```
public void wakeupReads()
```
    Specified by:
    
    wakeupReads in interface org.xnio.channels.SuspendableReadChannel
  - shutdownReads
```
public void shutdownReads()
                   throws IOException
```
    Specified by:
    
    shutdownReads in interface org.xnio.channels.SuspendableReadChannel
    
    Throws:
    
    IOException
  - awaitReadable
```
public void awaitReadable()
                   throws IOException
```
    Specified by:
    
    awaitReadable in interface org.xnio.channels.SuspendableReadChannel
    
    Throws:
    
    IOException
  - awaitReadable
```
public void awaitReadable(long time,
                          TimeUnit timeUnit)
                   throws IOException
```
    Specified by:
    
    awaitReadable in interface org.xnio.channels.SuspendableReadChannel
    
    Throws:
    
    IOException
  - getReadThread
```
public org.xnio.XnioExecutor getReadThread()
```
    Specified by:
    
    getReadThread in interface org.xnio.channels.SuspendableReadChannel
  - read
```
public int read(ByteBuffer dst)
         throws IOException
```
    Specified by:
    
    read in interface ReadableByteChannel
    
    Throws:
    
    IOException
  - getWorker
```
public org.xnio.XnioWorker getWorker()
```
    Specified by:
    
    getWorker in interface org.xnio.channels.CloseableChannel
  - getIoThread
```
public org.xnio.XnioIoThread getIoThread()
```
    Specified by:
    
    getIoThread in interface org.xnio.channels.CloseableChannel
  - supportsOption
```
public boolean supportsOption(org.xnio.Option<?> option)
```
    Specified by:
    
    supportsOption in interface org.xnio.channels.Configurable
  - getOption
```
public <T> T getOption(org.xnio.Option<T> option)
                throws IOException
```
    Specified by:
    
    getOption in interface org.xnio.channels.Configurable
    
    Throws:
    
    IOException
  - setOption
```
public <T> T setOption(org.xnio.Option<T> option,
                       T value)
                throws IOException
```
    Specified by:
    
    setOption in interface org.xnio.channels.Configurable
    
    Throws:
    
    IOException
  - isOpen
```
public boolean isOpen()
```
    Specified by:
    
    isOpen in interface Channel
  - 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
    
    Throws:
    
    IOException

Class ChannelFunctionStreamSourceChannel

Field Summary

Fields inherited from interface org.xnio.channels.Configurable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChannelFunctionStreamSourceChannel

Method Detail

transferTo

transferTo

getReadSetter

getCloseSetter

read

read

suspendReads

resumeReads

isReadResumed

wakeupReads

shutdownReads

awaitReadable

awaitReadable

getReadThread

read

getWorker

getIoThread

supportsOption

getOption

setOption

isOpen

close