org.jboss.xnio.channels
Interface StreamSinkChannel

All Superinterfaces:

java.nio.channels.Channel, java.io.Closeable, CloseableChannel, Configurable, java.nio.channels.GatheringByteChannel, SuspendableWriteChannel, java.nio.channels.WritableByteChannel

All Known Subinterfaces:

ConnectedStreamChannel<A>, LocalChannel, SslTcpChannel, StreamChannel, TcpChannel

public interface StreamSinkChannel
extends java.nio.channels.WritableByteChannel, java.nio.channels.GatheringByteChannel, SuspendableWriteChannel

A stream sink channel. This type of channel is a writable desination for bytes.

Method Summary

ChannelListener.Setter<? extends StreamSinkChannel>	getCloseSetter() Get the setter which can be used to change the close handler for this channel.
ChannelListener.Setter<? extends StreamSinkChannel>	getWriteSetter() Get the setter which can be used to change the write handler for this channel.
long	transferFrom(java.nio.channels.FileChannel src, long position, long count) Transfer bytes into this channel from the given file.

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 java.nio.channels.Channel

close, isOpen

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

getOption, setOption, supportsOption

Method Detail

transferFrom

long transferFrom(java.nio.channels.FileChannel src,
                  long position,
                  long count)
                  throws java.io.IOException

Transfer bytes into this channel from the given file. Using this method in preference to FileChannel.transferTo(long, long, java.nio.channels.WritableByteChannel) may provide a performance advantage on some platforms.

Parameters:

src - the file to read from

position - the position within the file from which the transfer is to begin

count - the number of bytes to be transferred

Returns:

the number of bytes (possibly 0) that were actually transferred

Throws:

java.io.IOException - if an I/O error occurs

getWriteSetter

ChannelListener.Setter<? extends StreamSinkChannel> 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

getCloseSetter

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

Returns:

the setter