org.xnio.channels

Class TranslatingSuspendableChannel<C extends SuspendableChannel,W extends SuspendableChannel>

java.lang.Object

org.xnio.channels.TranslatingSuspendableChannel<C,W>

Type Parameters:

C - the channel type implemented by this class

W - the channel type being wrapped by this class

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, InterruptibleChannel, CloseableChannel, Configurable, SuspendableChannel, SuspendableReadChannel, SuspendableWriteChannel, WrappedChannel<W>

Direct Known Subclasses:

FramedMessageChannel

public abstract class TranslatingSuspendableChannel<C extends SuspendableChannel,W extends SuspendableChannel>
extends Object
implements SuspendableChannel, WrappedChannel<W>

An abstract wrapped channel.

Author:

David M. Lloyd

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TranslatingSuspendableChannel.Readiness The readiness of this channel implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected W	channel The wrapped channel.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TranslatingSuspendableChannel(W channel) Construct a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	awaitReadable() Block until this channel becomes readable again.
void	awaitReadable(long time, TimeUnit timeUnit) Block until this channel becomes readable again, or until the timeout expires.
void	awaitWritable() Block until this channel becomes writable again.
void	awaitWritable(long time, TimeUnit timeUnit) Block until this channel becomes writable again, or until the timeout expires.
void	close() Base channel close implementation.
boolean	flush() Base implementation which delegates the flush request to the channel.
W	getChannel() Get the channel which is wrapped by this object.
ChannelListener.Setter<C>	getCloseSetter() Get the setter which can be used to change the close listener for this channel.
<T> T	getOption(Option<T> option) Get the value of a channel option.
protected abstract Object	getReadLock() Get the object to use as a read lock.
ChannelListener.Setter<C>	getReadSetter() Get the setter which can be used to change the read listener for this channel.
XnioExecutor	getReadThread() Get the read thread for this channel.
XnioWorker	getWorker() Get the worker for this channel.
protected abstract Object	getWriteLock() Get the object to use as a write lock.
ChannelListener.Setter<C>	getWriteSetter() Get the setter which can be used to change the write listener for this channel.
XnioExecutor	getWriteThread() Get the write thread for this channel.
protected void	handleReadable(W channel) Called when the underlying channel is readable.
protected void	handleWritable(W channel) Called when the underlying channel is writable.
boolean	isOpen()
protected abstract TranslatingSuspendableChannel.Readiness	isReadable() Determine whether this channel is known to be (or to not be) readable.
boolean	isReadResumed() Determine whether reads are resumed.
protected abstract TranslatingSuspendableChannel.Readiness	isWritable() Determine whether this channel is known to be (or to not be) writable.
boolean	isWriteResumed() Determine whether writes are resumed.
void	resumeReads() Resume reads on this channel.
protected void	resumeReadsIfRequested() Resume reads if the user has requested so.
protected void	resumeReadsIfRequestedAndSuspendWrites() Resume reads if the user has requested so.
void	resumeWrites() Resume writes on this channel.
protected void	resumeWritesIfRequested() Resume writes if the user has requested so.
protected void	resumeWritesIfRequestedAndSuspendReads()
<T> T	setOption(Option<T> option, T value) Set an option for this channel.
void	shutdownReads() Base implementation method which simply delegates the shutdown request to the delegate channel.
boolean	shutdownWrites() Base implementation method which simply delegates the shutdown request to the delegate channel.
boolean	supportsOption(Option<?> option) Determine whether an option is supported on this channel.
void	suspendReads() Suspend further read notifications on this channel.
void	suspendWrites() Suspend further write notifications on this channel.
protected C	thisTyped() Get this channel, cast to the implemented channel type.
String	toString()
void	wakeupReads() Resume reads on this channel, and force the read listener to be triggered even if the channel isn't actually readable.
void	wakeupReadsIfRequested()
void	wakeupWrites() Resume writes on this channel, and force the write listener to be triggered even if the channel isn't actually writable.
void	wakeupWritesIfRequested()

Methods inherited from class java.lang.Object

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

Field Detail

channel

protected final W extends SuspendableChannel channel

The wrapped channel.

Constructor Detail

TranslatingSuspendableChannel

protected TranslatingSuspendableChannel(W channel)

Construct a new instance.

Parameters:

channel - the channel being wrapped

Method Detail

handleReadable

protected void handleReadable(W channel)

Called when the underlying channel is readable.

Parameters:

channel - the underlying channel

handleWritable

protected void handleWritable(W channel)

Called when the underlying channel is writable.

Parameters:

channel - the underlying channel

thisTyped

protected final C thisTyped()

Get this channel, cast to the implemented channel type.

Returns:

this

getCloseSetter

public ChannelListener.Setter<C> getCloseSetter()

Get the setter which can be used to change the close listener for this channel. If the channel is already closed, then the listener will not be called.

Specified by:

getCloseSetter in interface CloseableChannel

Specified by:

getCloseSetter in interface SuspendableChannel

Specified by:

getCloseSetter in interface SuspendableReadChannel

Specified by:

getCloseSetter in interface SuspendableWriteChannel

Returns:

the setter

getReadSetter

public ChannelListener.Setter<C> getReadSetter()

Get the setter which can be used to change the read listener for this channel. When the listener is called, additional notifications are automatically suspended.

Specified by:

getReadSetter in interface SuspendableChannel

Specified by:

getReadSetter in interface SuspendableReadChannel

Returns:

the setter

getWriteSetter

public ChannelListener.Setter<C> getWriteSetter()

Get the setter which can be used to change the write listener for this channel. When the listener is called, additional notifications are automatically suspended.

Specified by:

getWriteSetter in interface SuspendableChannel

Specified by:

getWriteSetter in interface SuspendableWriteChannel

Returns:

the setter

suspendReads

public void suspendReads()

Suspend further read notifications on this channel.

Specified by:

suspendReads in interface SuspendableReadChannel

resumeReads

public void resumeReads()

Resume reads on this channel. The read listener will be called as soon as there is data available to be read.

Specified by:

resumeReads in interface SuspendableReadChannel

isReadResumed

public boolean isReadResumed()

Description copied from interface: SuspendableReadChannel

Determine whether reads are resumed.

Specified by:

isReadResumed in interface SuspendableReadChannel

Returns:

true if reads are resumed, false if reads are suspended

wakeupReads

public void wakeupReads()

Resume reads on this channel, and force the read listener to be triggered even if the channel isn't actually readable.

Specified by:

wakeupReads in interface SuspendableReadChannel

wakeupReadsIfRequested

public void wakeupReadsIfRequested()

resumeReadsIfRequested

protected void resumeReadsIfRequested()

Resume reads if the user has requested so.

resumeReadsIfRequestedAndSuspendWrites

protected void resumeReadsIfRequestedAndSuspendWrites()

Resume reads if the user has requested so.

suspendWrites

public void suspendWrites()

Suspend further write notifications on this channel.

Specified by:

suspendWrites in interface SuspendableWriteChannel

resumeWrites

public void resumeWrites()

Resume writes on this channel. The write listener will be called as soon as the channel becomes writable.

Specified by:

resumeWrites in interface SuspendableWriteChannel

isWriteResumed

public boolean isWriteResumed()

Description copied from interface: SuspendableWriteChannel

Determine whether writes are resumed.

Specified by:

isWriteResumed in interface SuspendableWriteChannel

Returns:

true if writes are resumed, false if writes are suspended

wakeupWrites

public void wakeupWrites()

Resume writes on this channel, and force the write listener to be triggered even if the channel isn't actually writable.

Specified by:

wakeupWrites in interface SuspendableWriteChannel

wakeupWritesIfRequested

public void wakeupWritesIfRequested()

resumeWritesIfRequested

protected void resumeWritesIfRequested()

Resume writes if the user has requested so.

resumeWritesIfRequestedAndSuspendReads

protected void resumeWritesIfRequestedAndSuspendReads()

supportsOption

public boolean supportsOption(Option<?> option)

Determine whether an option is supported on this channel.

Specified by:

supportsOption in interface Configurable

Parameters:

option - the option

Returns:

true if it is supported

getOption

public <T> T getOption(Option<T> option)
            throws IOException

Get the value of a channel option.

Specified by:

getOption in interface Configurable

Type Parameters:

T - the type of the option value

Parameters:

option - the option to get

Returns:

the value of the option, or null if it is not set

Throws:

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

setOption

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

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

Specified by:

setOption in interface Configurable

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

flush

public boolean flush()
              throws IOException

Base implementation which delegates the flush request to the channel. Subclasses should override this method as appropriate.

Specified by:

flush in interface SuspendableWriteChannel

Returns:

true if the flush completed, or false if the operation would block

Throws:

IOException - if an error occurs

shutdownReads

public void shutdownReads()
                   throws IOException

Base implementation method which simply delegates the shutdown request to the delegate channel. Subclasses may override this method and call up to this method as appropriate.

Specified by:

shutdownReads in interface SuspendableReadChannel

Throws:

IOException - if an I/O error occurs

shutdownWrites

public boolean shutdownWrites()
                       throws IOException

Base implementation method which simply delegates the shutdown request to the delegate channel. Subclasses may override this method and call up to this method as appropriate.

Specified by:

shutdownWrites in interface SuspendableWriteChannel

Returns:

true if the channel was shut down, or false if the operation would block

Throws:

IOException - if an I/O error occurs

awaitReadable

public void awaitReadable()
                   throws IOException

Block until this channel becomes readable again. This method may return spuriously before the channel becomes readable.

Specified by:

awaitReadable in interface SuspendableReadChannel

Throws:

InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well

IOException - if an I/O error occurs

awaitReadable

public void awaitReadable(long time,
                 TimeUnit timeUnit)
                   throws IOException

Block until this channel becomes readable again, or until the timeout expires. This method may return spuriously before the channel becomes readable or the timeout expires.

Specified by:

awaitReadable in interface SuspendableReadChannel

Parameters:

time - the time to wait

timeUnit - the time unit

Throws:

InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well

IOException - if an I/O error occurs

getReadThread

public XnioExecutor getReadThread()

Description copied from interface: SuspendableReadChannel

Get the read thread for this channel.

Specified by:

getReadThread in interface SuspendableReadChannel

Returns:

the thread, or null if none is configured or available

awaitWritable

public void awaitWritable()
                   throws IOException

Block until this channel becomes writable again. This method may return spuriously before the channel becomes writable.

Specified by:

awaitWritable in interface SuspendableWriteChannel

Throws:

InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well

IOException - if an I/O error occurs

awaitWritable

public void awaitWritable(long time,
                 TimeUnit timeUnit)
                   throws IOException

Block until this channel becomes writable again, or until the timeout expires. This method may return spuriously before the channel becomes writable or the timeout expires.

Specified by:

awaitWritable in interface SuspendableWriteChannel

Parameters:

time - the time to wait

timeUnit - the time unit

Throws:

InterruptedIOException - if the operation is interrupted; the thread's interrupt flag will be set as well

IOException - if an I/O error occurs

getWriteThread

public XnioExecutor getWriteThread()

Description copied from interface: SuspendableWriteChannel

Get the write thread for this channel.

Specified by:

getWriteThread in interface SuspendableWriteChannel

Returns:

the thread, or null if none is configured or available

close

public void close()
           throws IOException

Base channel close implementation. Delegates to the delegate channel by default.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface InterruptibleChannel

Throws:

IOException - if an I/O error occurs

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

getChannel

public W getChannel()

Get the channel which is wrapped by this object.

Specified by:

getChannel in interface WrappedChannel<W extends SuspendableChannel>

Returns:

the wrapped channel

isReadable

protected abstract TranslatingSuspendableChannel.Readiness isReadable()

Determine whether this channel is known to be (or to not be) readable. Called under the read lock.

Returns:

the readiness of this channel

getReadLock

protected abstract Object getReadLock()

Get the object to use as a read lock. Ensures that suspend/resume reads is atomic with respect to listener invocation.

Returns:

the read lock

isWritable

protected abstract TranslatingSuspendableChannel.Readiness isWritable()

Determine whether this channel is known to be (or to not be) writable. Called under the write lock.

Returns:

the readiness of this channel

getWriteLock

protected abstract Object getWriteLock()

Get the object to use as a write lock. Ensures that suspend/resume writes is atomic with respect to listener invocation.

Returns:

the write lock

getWorker

public XnioWorker getWorker()

Get the worker for this channel.

Specified by:

getWorker in interface CloseableChannel

Returns:

the worker

toString

public String toString()

Overrides:

toString in class Object