io.undertow.channels

Class GatedStreamSourceChannel

java.lang.Object

io.undertow.channels.GatedStreamSourceChannel

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 GatedStreamSourceChannel
extends Object
implements org.xnio.channels.StreamSourceChannel

A 'gated' stream source channel.

This channel has a gate which starts of closed. When the gate is closed reads will return 0. When the gate is opened reads will resume as normal.

Author:

David M. Lloyd

Field Summary

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Constructor and Description
GatedStreamSourceChannel(org.xnio.channels.StreamSourceChannel delegate) Construct a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	awaitReadable()
void	awaitReadable(long time, TimeUnit timeUnit)
void	close()
org.xnio.channels.StreamSourceChannel	getChannel() Get the underlying channel if the gate is open, else return this channel.
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	isGateOpen()
boolean	isOpen()
boolean	isReadResumed()
void	openGate() Open the gate and allow data to flow.
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

GatedStreamSourceChannel

public GatedStreamSourceChannel(org.xnio.channels.StreamSourceChannel delegate)

Construct a new instance.

Parameters:

delegate - the channel to wrap

Method Detail

openGate

public void openGate()
              throws IOException

Open the gate and allow data to flow. Once opened, the gate cannot be closed other than closing the channel.

If the shutdownReads() or close() method has already been called this will result it in being invoked on the delegate.

Throws:

IOException

isGateOpen

public boolean isGateOpen()

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

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

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

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

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

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

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

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

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 IllegalArgumentException,
                   IOException

Specified by:

setOption in interface org.xnio.channels.Configurable

Throws:

IllegalArgumentException

IOException

getChannel

public org.xnio.channels.StreamSourceChannel getChannel()

Get the underlying channel if the gate is open, else return this channel.

Returns:

the underlying channel, or this channel if the gate is not open