org.jboss.xnio.channels
Interface MultipointWritableMessageChannel<A>

Type Parameters:

A - the type of address associated with this channel

All Superinterfaces:

Channel, Closeable, CloseableChannel, Configurable, SuspendableWriteChannel

All Known Subinterfaces:

MultipointDatagramChannel<A>, MultipointMessageChannel<A>, UdpChannel

public interface MultipointWritableMessageChannel<A>
extends SuspendableWriteChannel

The writable side of a multipoint message channel.

See Also:

MultipointMessageChannel

Method Summary

ChannelListener.Setter<? extends MultipointWritableMessageChannel<A>>	getCloseSetter() Get the setter which can be used to change the close listener for this channel.
ChannelListener.Setter<? extends MultipointWritableMessageChannel<A>>	getWriteSetter() Get the setter which can be used to change the write listener for this channel.
boolean	send(A target, ByteBuffer buffer) Send a buffer to a destination.
boolean	send(A target, ByteBuffer[] buffers) Send a message with data from multiple buffers to a destination.
boolean	send(A target, ByteBuffer[] buffers, int offset, int length) Send a message with data from multiple buffers to a destination.

Methods inherited from interface org.jboss.xnio.channels.SuspendableWriteChannel

awaitWritable, awaitWritable, flush, resumeWrites, shutdownWrites, suspendWrites

Methods inherited from interface java.nio.channels.Channel

close, isOpen

Methods inherited from interface org.jboss.xnio.channels.Configurable

getOption, setOption, supportsOption

Method Detail

send

boolean send(A target,
             ByteBuffer buffer)
             throws IOException

Send a buffer to a destination.

Parameters:

target - the destination

buffer - the data to send

Returns:

true if the message was sent, or false if the channel is not currently writable

Throws:

IOException - if an I/O error occurs

send

boolean send(A target,
             ByteBuffer[] buffers)
             throws IOException

Send a message with data from multiple buffers to a destination.

Parameters:

target - the destination

buffers - the data to send

Returns:

true if the message was sent, or false if the channel is not currently writable

Throws:

IOException - if an I/O error occurs

send

boolean send(A target,
             ByteBuffer[] buffers,
             int offset,
             int length)
             throws IOException

Send a message with data from multiple buffers to a destination.

Parameters:

target - the destination

buffers - the data to send

offset - the offset into the buffers array

length - the number of buffers to read from

Returns:

true if the message was sent, or false if the channel is not currently writable

Throws:

IOException - if an I/O error occurs

getWriteSetter

ChannelListener.Setter<? extends MultipointWritableMessageChannel<A>> 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 SuspendableWriteChannel

Returns:

the setter

getCloseSetter

ChannelListener.Setter<? extends MultipointWritableMessageChannel<A>> 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 SuspendableWriteChannel

Returns:

the setter