XNIO API 2.0.0.GA

org.jboss.xnio.channels
Interface StreamChannel

All Superinterfaces:
java.nio.channels.Channel, java.io.Closeable, CloseableChannel, Configurable, java.nio.channels.GatheringByteChannel, java.nio.channels.ReadableByteChannel, java.nio.channels.ScatteringByteChannel, StreamSinkChannel, StreamSourceChannel, SuspendableChannel, SuspendableReadChannel, SuspendableWriteChannel, java.nio.channels.WritableByteChannel
All Known Subinterfaces:
ConnectedStreamChannel<A>, LocalChannel, SslTcpChannel, TcpChannel

public interface StreamChannel
extends SuspendableChannel, StreamSinkChannel, StreamSourceChannel

A stream channel. This type of channel represents a stream of bytes flowing in two directions.


Method Summary
 ChannelListener.Setter<? extends StreamChannel> getCloseSetter()
          Get the setter which can be used to change the close handler for this channel.
 ChannelListener.Setter<? extends StreamChannel> getReadSetter()
          Get the setter which can be used to change the read handler for this channel.
 ChannelListener.Setter<? extends StreamChannel> getWriteSetter()
          Get the setter which can be used to change the write handler for this channel.
 
Methods inherited from interface org.jboss.xnio.channels.StreamSinkChannel
transferFrom
 
Methods inherited from interface java.nio.channels.GatheringByteChannel
write, write
 
Methods inherited from interface java.nio.channels.WritableByteChannel
write
 
Methods inherited from interface org.jboss.xnio.channels.SuspendableWriteChannel
awaitWritable, awaitWritable, flush, resumeWrites, shutdownWrites, suspendWrites
 
Methods inherited from interface org.jboss.xnio.channels.StreamSourceChannel
transferTo
 
Methods inherited from interface java.nio.channels.ScatteringByteChannel
read, read
 
Methods inherited from interface java.nio.channels.ReadableByteChannel
read
 
Methods inherited from interface org.jboss.xnio.channels.SuspendableReadChannel
awaitReadable, awaitReadable, resumeReads, shutdownReads, suspendReads
 
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 StreamChannel> 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 StreamSourceChannel
Specified by:
getReadSetter in interface SuspendableChannel
Specified by:
getReadSetter in interface SuspendableReadChannel
Returns:
the setter

getWriteSetter

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

getCloseSetter

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

XNIO API 2.0.0.GA

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