org.xnio.channels

Interface StreamChannel

All Superinterfaces:

AutoCloseable, ByteChannel, Channel, Closeable, CloseableChannel, Configurable, GatheringByteChannel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, StreamSinkChannel, StreamSourceChannel, SuspendableChannel, SuspendableReadChannel, SuspendableWriteChannel, WritableByteChannel

All Known Subinterfaces:

ConnectedSslStreamChannel, ConnectedStreamChannel

public interface StreamChannel
extends SuspendableChannel, StreamSinkChannel, StreamSourceChannel, ByteChannel

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

Method Summary

Methods

Modifier and Type	Method and Description
ChannelListener.Setter<? extends StreamChannel>	getCloseSetter() Get the setter which can be used to change the close listener for this channel.
ChannelListener.Setter<? extends StreamChannel>	getReadSetter() Get the setter which can be used to change the read listener for this channel.
ChannelListener.Setter<? extends StreamChannel>	getWriteSetter() Get the setter which can be used to change the write listener for this channel.

Methods inherited from interface org.xnio.channels.StreamSinkChannel

transferFrom, transferFrom

Methods inherited from interface org.xnio.channels.SuspendableWriteChannel

awaitWritable, awaitWritable, close, flush, getWriteThread, isWriteResumed, resumeWrites, shutdownWrites, suspendWrites, wakeupWrites

Methods inherited from interface org.xnio.channels.StreamSourceChannel

transferTo, transferTo

Methods inherited from interface org.xnio.channels.SuspendableReadChannel

awaitReadable, awaitReadable, getReadThread, isReadResumed, resumeReads, shutdownReads, suspendReads, wakeupReads

Methods inherited from interface org.xnio.channels.CloseableChannel

getWorker

Methods inherited from interface org.xnio.channels.Configurable

getOption, setOption, supportsOption

Methods inherited from interface java.nio.channels.GatheringByteChannel

write, write

Methods inherited from interface java.nio.channels.WritableByteChannel

write

Methods inherited from interface java.nio.channels.ScatteringByteChannel

read, read

Methods inherited from interface java.nio.channels.ReadableByteChannel

read

Method Detail

getReadSetter

ChannelListener.Setter<? extends StreamChannel> getReadSetter()

Get the setter which can be used to change the read listener for this channel. When the listener 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 listener for this channel. When the listener 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 listener for this channel. If the channel is already closed, then the listener 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