org.xnio.conduits

Class ConduitReadableMessageChannel

java.lang.Object

org.xnio.conduits.ConduitReadableMessageChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, Channel, InterruptibleChannel, CloseableChannel, CloseListenerSettable<ConduitReadableMessageChannel>, Configurable, ReadableMessageChannel, ReadListenerSettable<ConduitReadableMessageChannel>, SuspendableReadChannel

public final class ConduitReadableMessageChannel
extends Object
implements ReadableMessageChannel, ReadListenerSettable<ConduitReadableMessageChannel>, CloseListenerSettable<ConduitReadableMessageChannel>, Cloneable

A readable message channel which is backed by a message source conduit.

Author:

David M. Lloyd

Nested Class Summary

Nested classes/interfaces inherited from interface org.xnio.channels.ReadListenerSettable

ReadListenerSettable.Setter<C extends Channel>

Nested classes/interfaces inherited from interface org.xnio.channels.CloseListenerSettable

CloseListenerSettable.Setter<C extends Channel>

Field Summary

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Constructor and Description
ConduitReadableMessageChannel(Configurable configurable, MessageSourceConduit conduit) Construct a new instance.

Method Summary

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.
ConduitReadableMessageChannel	clone() Duplicate this channel.
void	close() Close this channel.
ChannelListener<? super ConduitReadableMessageChannel>	getCloseListener() Get the close listener.
ChannelListener.Setter<ConduitReadableMessageChannel>	getCloseSetter() Get the setter which can be used to change the close listener for this channel.
MessageSourceConduit	getConduit() Get the underlying conduit for this channel.
XnioIoThread	getIoThread() Get the I/O thread associated with this channel.
<T> T	getOption(Option<T> option) Get the value of a channel option.
ChannelListener<? super ConduitReadableMessageChannel>	getReadListener() Get the read listener.
ChannelListener.Setter<ConduitReadableMessageChannel>	getReadSetter() Get the setter which can be used to change the read listener for this channel.
XnioExecutor	getReadThread() Deprecated.
XnioWorker	getWorker() Get the worker for this channel.
boolean	isOpen()
boolean	isReadResumed() Determine whether reads are resumed.
int	receive(ByteBuffer dst) Receive a message.
long	receive(ByteBuffer[] dsts) Receive a message.
long	receive(ByteBuffer[] dsts, int offset, int length) Receive a message.
void	resumeReads() Resume reads on this channel.
void	setCloseListener(ChannelListener<? super ConduitReadableMessageChannel> closeListener) Set the close listener.
void	setConduit(MessageSourceConduit conduit) Set the underlying conduit for this channel.
<T> T	setOption(Option<T> option, T value) Set an option for this channel.
void	setReadListener(ChannelListener<? super ConduitReadableMessageChannel> readListener) Set the read listener.
void	shutdownReads() Places this readable channel at "end of stream".
boolean	supportsOption(Option<?> option) Determine whether an option is supported on this channel.
void	suspendReads() Suspend further read notifications on this channel.
void	wakeupReads() Resume reads on this channel, and force the read listener to be triggered even if the channel isn't actually readable.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConduitReadableMessageChannel

public ConduitReadableMessageChannel(Configurable configurable,
                                     MessageSourceConduit conduit)

Construct a new instance.

Parameters:

configurable - the configurable to delegate configuration requests to

conduit - the initial conduit to use for data transport

Method Detail

getConduit

public MessageSourceConduit getConduit()

Get the underlying conduit for this channel.

Returns:

the underlying conduit for this channel

setConduit

public void setConduit(MessageSourceConduit conduit)

Set the underlying conduit for this channel.

Parameters:

conduit - the underlying conduit for this channel

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

setReadListener

public void setReadListener(ChannelListener<? super ConduitReadableMessageChannel> readListener)

Description copied from interface: ReadListenerSettable

Set the read listener.

Specified by:

setReadListener in interface ReadListenerSettable<ConduitReadableMessageChannel>

Parameters:

readListener - the read listener

getReadListener

public ChannelListener<? super ConduitReadableMessageChannel> getReadListener()

Description copied from interface: ReadListenerSettable

Get the read listener.

Specified by:

getReadListener in interface ReadListenerSettable<ConduitReadableMessageChannel>

Returns:

the read listener

setCloseListener

public void setCloseListener(ChannelListener<? super ConduitReadableMessageChannel> closeListener)

Description copied from interface: CloseListenerSettable

Set the close listener.

Specified by:

setCloseListener in interface CloseListenerSettable<ConduitReadableMessageChannel>

Parameters:

closeListener - the close listener

getCloseListener

public ChannelListener<? super ConduitReadableMessageChannel> getCloseListener()

Description copied from interface: CloseListenerSettable

Get the close listener.

Specified by:

getCloseListener in interface CloseListenerSettable<ConduitReadableMessageChannel>

Returns:

the close listener

getReadSetter

public ChannelListener.Setter<ConduitReadableMessageChannel> getReadSetter()

Description copied from interface: ReadableMessageChannel

Get the setter which can be used to change the read listener for this channel.

Specified by:

getReadSetter in interface ReadableMessageChannel

Specified by:

getReadSetter in interface SuspendableReadChannel

Returns:

the setter

getCloseSetter

public ChannelListener.Setter<ConduitReadableMessageChannel> getCloseSetter()

Description copied from interface: ReadableMessageChannel

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 ReadableMessageChannel

Specified by:

getCloseSetter in interface SuspendableReadChannel

Returns:

the setter

getWorker

public XnioWorker getWorker()

Description copied from interface: CloseableChannel

Get the worker for this channel.

Specified by:

getWorker in interface CloseableChannel

Returns:

the worker

receive

public long receive(ByteBuffer[] dsts,
                    int offset,
                    int length)
             throws IOException

Description copied from interface: ReadableMessageChannel

Receive a message.

Specified by:

receive in interface ReadableMessageChannel

Parameters:

dsts - the buffers that will hold the message

offset - the offset into the array of buffers of the first buffer to read into

length - the number of buffers to fill

Returns:

the size of the received message, 0 if no message is available, and -1 if the message channel has reached an end-of-file condition

Throws:

IOException - if an I/O error occurs

receive

public long receive(ByteBuffer[] dsts)
             throws IOException

Description copied from interface: ReadableMessageChannel

Receive a message.

Specified by:

receive in interface ReadableMessageChannel

Parameters:

dsts - the buffers that will hold the message

Returns:

the size of the received message, 0 if no message is available, and -1 if the message channel has reached an end-of-file condition

Throws:

IOException - if an I/O error occurs

receive

public int receive(ByteBuffer dst)
            throws IOException

Description copied from interface: ReadableMessageChannel

Receive a message.

Specified by:

receive in interface ReadableMessageChannel

Parameters:

dst - the buffer that will hold the message

Returns:

the size of the received message, 0 if no message is available, and -1 if the message channel has reached an end-of-file condition

Throws:

IOException - if an I/O error occurs

suspendReads

public void suspendReads()

Description copied from interface: SuspendableReadChannel

Suspend further read notifications on this channel.

Specified by:

suspendReads in interface SuspendableReadChannel

resumeReads

public void resumeReads()

Description copied from interface: SuspendableReadChannel

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()

Description copied from interface: SuspendableReadChannel

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

shutdownReads

public void shutdownReads()
                   throws IOException

Description copied from interface: SuspendableReadChannel

Places this readable channel at "end of stream". Further reads will result in EOF. Shutting down all directions of a channel will cause CloseableChannel.close() to be called automatically.

Specified by:

shutdownReads in interface SuspendableReadChannel

Throws:

IOException - if an I/O error occurs

awaitReadable

public void awaitReadable()
                   throws IOException

Description copied from interface: SuspendableReadChannel

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

Description copied from interface: SuspendableReadChannel

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

@Deprecated
public XnioExecutor getReadThread()

Deprecated.

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

getIoThread

public XnioIoThread getIoThread()

Description copied from interface: CloseableChannel

Get the I/O thread associated with this channel.

Specified by:

getIoThread in interface CloseableChannel

Returns:

the I/O thread associated with this channel

close

public void close()
           throws IOException

Description copied from interface: CloseableChannel

Close this channel. When a channel is closed, its close listener is invoked. Invoking this method more than once has no additional effect.

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 CloseableChannel

Throws:

IOException - if the close failed

supportsOption

public boolean supportsOption(Option<?> option)

Description copied from interface: Configurable

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

Description copied from interface: Configurable

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

Description copied from interface: Configurable

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

clone

public ConduitReadableMessageChannel clone()

Duplicate this channel. Changing the delegate conduit in one channel will not affect the other.

Overrides:

clone in class Object

Returns:

the cloned channel