XNIO API 2.0.0.GA

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

Type Parameters:
A - the type of address associated with this channel
All Superinterfaces:
java.nio.channels.Channel, java.io.Closeable, CloseableChannel, Configurable, MultipointReadableMessageChannel<A>, MultipointWritableMessageChannel<A>, SuspendableChannel, SuspendableReadChannel, SuspendableWriteChannel
All Known Subinterfaces:
MultipointDatagramChannel<A>, UdpChannel

public interface MultipointMessageChannel<A>
extends MultipointReadableMessageChannel<A>, MultipointWritableMessageChannel<A>, SuspendableChannel

A point-to-multipoint message channel. This type of channel is capable of sending to and receiving from multiple peer endpoints; as such, the incoming and outgoing messages are each associated with a peer address.


Method Summary
 ChannelListener.Setter<? extends MultipointMessageChannel<A>> getCloseSetter()
          Get the setter which can be used to change the close handler for this channel.
 ChannelListener.Setter<? extends MultipointMessageChannel<A>> getReadSetter()
          Get the setter which can be used to change the read handler for this channel.
 ChannelListener.Setter<? extends MultipointMessageChannel<A>> getWriteSetter()
          Get the setter which can be used to change the write handler for this channel.
 
Methods inherited from interface org.jboss.xnio.channels.MultipointReadableMessageChannel
receive
 
Methods inherited from interface org.jboss.xnio.channels.MultipointWritableMessageChannel
send, send, send
 
Methods inherited from interface org.jboss.xnio.channels.SuspendableReadChannel
awaitReadable, awaitReadable, resumeReads, shutdownReads, suspendReads
 
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

getReadSetter

ChannelListener.Setter<? extends MultipointMessageChannel<A>> getReadSetter()
Get the setter which can be used to change the read handler for this channel. When the handler is called, additional notifications are automatically suspended.

Specified by:
getReadSetter in interface MultipointReadableMessageChannel<A>
Specified by:
getReadSetter in interface SuspendableChannel
Specified by:
getReadSetter in interface SuspendableReadChannel
Returns:
the setter

getCloseSetter

ChannelListener.Setter<? extends MultipointMessageChannel<A>> getCloseSetter()
Get the setter which can be used to change the close handler for this channel. If the channel is already closed, then the handler will not be called.

Specified by:
getCloseSetter in interface CloseableChannel
Specified by:
getCloseSetter in interface MultipointReadableMessageChannel<A>
Specified by:
getCloseSetter in interface MultipointWritableMessageChannel<A>
Specified by:
getCloseSetter in interface SuspendableChannel
Specified by:
getCloseSetter in interface SuspendableReadChannel
Specified by:
getCloseSetter in interface SuspendableWriteChannel
Returns:
the setter

getWriteSetter

ChannelListener.Setter<? extends MultipointMessageChannel<A>> getWriteSetter()
Get the setter which can be used to change the write handler for this channel. When the handler is called, additional notifications are automatically suspended.

Specified by:
getWriteSetter in interface MultipointWritableMessageChannel<A>
Specified by:
getWriteSetter in interface SuspendableChannel
Specified by:
getWriteSetter in interface SuspendableWriteChannel
Returns:
the setter

XNIO API 2.0.0.GA

Copyright © 2009 JBoss, a division of Red Hat, Inc.