XNIO API 2.0.0.GA

org.jboss.xnio.channels
Interface MessageChannel

All Superinterfaces:
java.nio.channels.Channel, java.io.Closeable, CloseableChannel, Configurable, ReadableMessageChannel, SuspendableChannel, SuspendableReadChannel, SuspendableWriteChannel, WritableMessageChannel
All Known Subinterfaces:
DatagramChannel<A>

public interface MessageChannel
extends ReadableMessageChannel, WritableMessageChannel, SuspendableChannel

A channel that sends and receives whole messages.


Method Summary
 ChannelListener.Setter<? extends MessageChannel> getCloseSetter()
          Get the setter which can be used to change the close handler for this channel.
 ChannelListener.Setter<? extends MessageChannel> getReadSetter()
          Get the setter which can be used to change the read handler for this channel.
 ChannelListener.Setter<? extends MessageChannel> getWriteSetter()
          Get the setter which can be used to change the write handler for this channel.
 
Methods inherited from interface org.jboss.xnio.channels.ReadableMessageChannel
receive, receive, receive
 
Methods inherited from interface org.jboss.xnio.channels.WritableMessageChannel
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 MessageChannel> 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 ReadableMessageChannel
Specified by:
getReadSetter in interface SuspendableChannel
Specified by:
getReadSetter in interface SuspendableReadChannel
Returns:
the setter

getCloseSetter

ChannelListener.Setter<? extends MessageChannel> 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 ReadableMessageChannel
Specified by:
getCloseSetter in interface SuspendableChannel
Specified by:
getCloseSetter in interface SuspendableReadChannel
Specified by:
getCloseSetter in interface SuspendableWriteChannel
Specified by:
getCloseSetter in interface WritableMessageChannel
Returns:
the setter

getWriteSetter

ChannelListener.Setter<? extends MessageChannel> 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 SuspendableChannel
Specified by:
getWriteSetter in interface SuspendableWriteChannel
Specified by:
getWriteSetter in interface WritableMessageChannel
Returns:
the setter

XNIO API 2.0.0.GA

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