org.xnio.conduits

Class ConduitWritableMessageChannel

java.lang.Object

org.xnio.conduits.ConduitWritableMessageChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable, Channel, InterruptibleChannel, CloseableChannel, CloseListenerSettable<ConduitWritableMessageChannel>, Configurable, SuspendableWriteChannel, WritableMessageChannel, WriteListenerSettable<ConduitWritableMessageChannel>

public final class ConduitWritableMessageChannel
extends Object
implements WritableMessageChannel, WriteListenerSettable<ConduitWritableMessageChannel>, CloseListenerSettable<ConduitWritableMessageChannel>, Cloneable

A writable message channel which is backed by a message sink conduit.

Author:

David M. Lloyd

Nested Class Summary

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

WriteListenerSettable.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
ConduitWritableMessageChannel(Configurable configurable, MessageSinkConduit conduit) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
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.
ConduitWritableMessageChannel	clone() Duplicate this channel.
void	close() Close this channel.
boolean	flush() Flush any waiting partial send or write.
ChannelListener<? super ConduitWritableMessageChannel>	getCloseListener() Get the close listener.
ChannelListener.Setter<ConduitWritableMessageChannel>	getCloseSetter() Get the setter which can be used to change the close listener for this channel.
MessageSinkConduit	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.
XnioWorker	getWorker() Get the worker for this channel.
ChannelListener<? super ConduitWritableMessageChannel>	getWriteListener() Get the write listener.
ChannelListener.Setter<ConduitWritableMessageChannel>	getWriteSetter() Get the setter which can be used to change the write listener for this channel.
XnioExecutor	getWriteThread() Deprecated.
boolean	isOpen() Determine whether this channel is open.
boolean	isWriteResumed() Determine whether writes are resumed.
void	resumeWrites() Resume writes on this channel.
boolean	send(ByteBuffer dst) Send a complete message.
boolean	send(ByteBuffer[] srcs) Send a complete message.
boolean	send(ByteBuffer[] dsts, int offs, int len) Send a complete message.
boolean	sendFinal(ByteBuffer buffer) Send a complete message.
boolean	sendFinal(ByteBuffer[] buffers) Send a complete message.
boolean	sendFinal(ByteBuffer[] buffers, int offs, int len) Send a complete message.
void	setCloseListener(ChannelListener<? super ConduitWritableMessageChannel> closeListener) Set the close listener.
void	setConduit(MessageSinkConduit conduit) Set the underlying conduit for this channel.
<T> T	setOption(Option<T> option, T value) Set an option for this channel.
void	setWriteListener(ChannelListener<? super ConduitWritableMessageChannel> writeListener) Set the write listener.
void	shutdownWrites() Indicate that writing is complete for this channel.
boolean	supportsOption(Option<?> option) Determine whether an option is supported on this channel.
void	suspendWrites() Suspend further write notifications on this channel.
void	wakeupWrites() Resume writes on this channel, and force the write listener to be triggered even if the channel isn't actually writable.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConduitWritableMessageChannel

public ConduitWritableMessageChannel(Configurable configurable,
                                     MessageSinkConduit 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 MessageSinkConduit getConduit()

Get the underlying conduit for this channel.

Returns:

the underlying conduit for this channel

setConduit

public void setConduit(MessageSinkConduit conduit)

Set the underlying conduit for this channel.

Parameters:

conduit - the underlying conduit for this channel

getWriteListener

public ChannelListener<? super ConduitWritableMessageChannel> getWriteListener()

Description copied from interface: WriteListenerSettable

Get the write listener.

Specified by:

getWriteListener in interface WriteListenerSettable<ConduitWritableMessageChannel>

Returns:

the write listener

setWriteListener

public void setWriteListener(ChannelListener<? super ConduitWritableMessageChannel> writeListener)

Description copied from interface: WriteListenerSettable

Set the write listener.

Specified by:

setWriteListener in interface WriteListenerSettable<ConduitWritableMessageChannel>

Parameters:

writeListener - the write listener

getCloseListener

public ChannelListener<? super ConduitWritableMessageChannel> getCloseListener()

Description copied from interface: CloseListenerSettable

Get the close listener.

Specified by:

getCloseListener in interface CloseListenerSettable<ConduitWritableMessageChannel>

Returns:

the close listener

setCloseListener

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

Description copied from interface: CloseListenerSettable

Set the close listener.

Specified by:

setCloseListener in interface CloseListenerSettable<ConduitWritableMessageChannel>

Parameters:

closeListener - the close listener

getWriteSetter

public ChannelListener.Setter<ConduitWritableMessageChannel> getWriteSetter()

Description copied from interface: WritableMessageChannel

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

Specified by:

getWriteSetter in interface SuspendableWriteChannel

Specified by:

getWriteSetter in interface WritableMessageChannel

Returns:

the setter

getCloseSetter

public ChannelListener.Setter<ConduitWritableMessageChannel> getCloseSetter()

Description copied from interface: WritableMessageChannel

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 SuspendableWriteChannel

Specified by:

getCloseSetter in interface WritableMessageChannel

Returns:

the setter

suspendWrites

public void suspendWrites()

Description copied from interface: SuspendableWriteChannel

Suspend further write notifications on this channel.

Specified by:

suspendWrites in interface SuspendableWriteChannel

resumeWrites

public void resumeWrites()

Description copied from interface: SuspendableWriteChannel

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

Specified by:

resumeWrites in interface SuspendableWriteChannel

wakeupWrites

public void wakeupWrites()

Description copied from interface: SuspendableWriteChannel

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

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

awaitWritable

public void awaitWritable()
                   throws IOException

Description copied from interface: SuspendableWriteChannel

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

Description copied from interface: SuspendableWriteChannel

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

send

public boolean send(ByteBuffer dst)
             throws IOException

Description copied from interface: WritableMessageChannel

Send a complete message.

Specified by:

send in interface WritableMessageChannel

Parameters:

dst - the message to send

Returns:

the result of the send operation; true if the message was sent, or false if it would block

Throws:

IOException - if an I/O error occurs

send

public boolean send(ByteBuffer[] srcs)
             throws IOException

Description copied from interface: WritableMessageChannel

Send a complete message.

Specified by:

send in interface WritableMessageChannel

Parameters:

srcs - the buffers holding the message to send

Returns:

the result of the send operation; true if the message was sent, or false if it would block

Throws:

IOException - if an I/O error occurs

send

public boolean send(ByteBuffer[] dsts,
                    int offs,
                    int len)
             throws IOException

Description copied from interface: WritableMessageChannel

Send a complete message.

Specified by:

send in interface WritableMessageChannel

Parameters:

dsts - the buffers holding the message to send

offs - the offset into the buffer array of the first buffer

len - the number of buffers that contain data to send

Returns:

the result of the send operation; true if the message was sent, or false if it would block

Throws:

IOException - if an I/O error occurs

sendFinal

public boolean sendFinal(ByteBuffer buffer)
                  throws IOException

Description copied from interface: WritableMessageChannel

Send a complete message. If the message was successfully sent the channel with have its writes shutdown.

Specified by:

sendFinal in interface WritableMessageChannel

Parameters:

buffer - the message to send

Returns:

the result of the send operation; true if the message was sent, or false if it would block

Throws:

IOException - if an I/O error occurs

sendFinal

public boolean sendFinal(ByteBuffer[] buffers)
                  throws IOException

Description copied from interface: WritableMessageChannel

Send a complete message. If the message was successfully sent the channel with have its writes shutdown.

Specified by:

sendFinal in interface WritableMessageChannel

Parameters:

buffers - the buffers holding the message to send

Returns:

the result of the send operation; true if the message was sent, or false if it would block

Throws:

IOException - if an I/O error occurs

sendFinal

public boolean sendFinal(ByteBuffer[] buffers,
                         int offs,
                         int len)
                  throws IOException

Description copied from interface: WritableMessageChannel

Send a complete message. If the message was successfully sent the channel with have its writes shutdown.

Specified by:

sendFinal in interface WritableMessageChannel

Parameters:

buffers - the buffers holding the message to send

offs - the offset into the buffer array of the first buffer

len - the number of buffers that contain data to send

Returns:

the result of the send operation; true if the message was sent, or false if it would block

Throws:

IOException - if an I/O error occurs

flush

public boolean flush()
              throws IOException

Description copied from interface: SuspendableWriteChannel

Flush any waiting partial send or write. If there is no data to flush, or if the flush completed successfully, this method will return true. If there is data to flush which cannot be immediately written, this method will return false. If this method returns true after SuspendableWriteChannel.shutdownWrites() was called on this channel, the write listener will no longer be invoked on this channel. If this is case and additionally this is a write-only channel or the read side was previously shut down, then the channel will automatically be closed.

Specified by:

flush in interface SuspendableWriteChannel

Returns:

true if the message was flushed, or false if the result would block

Throws:

IOException - if an I/O error occurs

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

shutdownWrites

public void shutdownWrites()
                    throws IOException

Description copied from interface: SuspendableWriteChannel

Indicate that writing is complete for this channel. Further attempts to write data to this channel after this method is invoked will result in an exception. If this method was already called, calling this method again will have no additional effect. After this method is called, any remaining data still must be flushed out via the SuspendableWriteChannel.flush() method; once this is done, if the read side of the channel was shut down, the channel will automatically close.

Specified by:

shutdownWrites in interface SuspendableWriteChannel

Throws:

IOException - if an I/O error occurs

isOpen

public boolean isOpen()

Description copied from interface: SuspendableWriteChannel

Determine whether this channel is open. This method will return false if all directions are shut down, even if there is unflushed write data pending.

Specified by:

isOpen in interface Channel

Specified by:

isOpen in interface SuspendableWriteChannel

Returns:

true if the channel is open, false otherwise

close

public void close()
           throws IOException

Description copied from interface: SuspendableWriteChannel

Close this channel. If data has been written but not flushed, that data may be discarded, depending on the channel implementation. 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

Specified by:

close in interface SuspendableWriteChannel

Throws:

IOException - if the close failed

getWriteThread

@Deprecated
public XnioExecutor getWriteThread()

Deprecated.

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

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

getWorker

public XnioWorker getWorker()

Description copied from interface: CloseableChannel

Get the worker for this channel.

Specified by:

getWorker in interface CloseableChannel

Returns:

the worker

clone

public ConduitWritableMessageChannel 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