XNIO API 2.0.0.GA

org.jboss.xnio.channels
Interface SuspendableChannel

All Superinterfaces:
java.nio.channels.Channel, java.io.Closeable, CloseableChannel, Configurable, SuspendableReadChannel, SuspendableWriteChannel
All Known Subinterfaces:
ConnectedStreamChannel<A>, DatagramChannel<A>, LocalChannel, MessageChannel, MultipointDatagramChannel<A>, MultipointMessageChannel<A>, SslTcpChannel, StreamChannel, TcpChannel, UdpChannel

public interface SuspendableChannel
extends CloseableChannel, SuspendableReadChannel, SuspendableWriteChannel

A suspendable bidirectional channel.


Method Summary
 ChannelListener.Setter<? extends SuspendableChannel> getCloseSetter()
          Get the setter which can be used to change the close handler for this channel.
 ChannelListener.Setter<? extends SuspendableChannel> getReadSetter()
          Get the setter which can be used to change the read handler for this channel.
 ChannelListener.Setter<? extends SuspendableChannel> getWriteSetter()
          Get the setter which can be used to change the write handler for this channel.
 
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

getCloseSetter

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

getReadSetter

ChannelListener.Setter<? extends SuspendableChannel> 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 SuspendableReadChannel
Returns:
the setter

getWriteSetter

ChannelListener.Setter<? extends SuspendableChannel> 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 SuspendableWriteChannel
Returns:
the setter

XNIO API 2.0.0.GA

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