Package org.xnio.channels
Interface StreamChannel
- All Superinterfaces:
AutoCloseable
,ByteChannel
,ByteChannel
,Channel
,Closeable
,CloseableChannel
,Configurable
,GatheringByteChannel
,InterruptibleChannel
,ReadableByteChannel
,ScatteringByteChannel
,StreamSinkChannel
,StreamSourceChannel
,SuspendableChannel
,SuspendableReadChannel
,SuspendableWriteChannel
,WritableByteChannel
- All Known Subinterfaces:
ConnectedSslStreamChannel
,ConnectedStreamChannel
- All Known Implementing Classes:
AssembledConnectedSslStreamChannel
,AssembledConnectedStreamChannel
,AssembledStreamChannel
public interface StreamChannel
extends SuspendableChannel, StreamSinkChannel, StreamSourceChannel, ByteChannel
A stream channel. This type of channel represents a stream of bytes flowing in two directions.
-
Field Summary
Fields inherited from interface org.xnio.channels.Configurable
EMPTY
-
Method Summary
Modifier and TypeMethodDescriptionChannelListener.Setter
<? extends StreamChannel> Get the setter which can be used to change the close listener for this channel.ChannelListener.Setter
<? extends StreamChannel> Get the setter which can be used to change the read listener for this channel.ChannelListener.Setter
<? extends StreamChannel> Get the setter which can be used to change the write listener for this channel.Methods inherited from interface org.xnio.channels.CloseableChannel
getIoThread, 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.ReadableByteChannel
read
Methods inherited from interface java.nio.channels.ScatteringByteChannel
read, read
Methods inherited from interface org.xnio.channels.StreamSinkChannel
transferFrom, transferFrom, writeFinal, writeFinal, writeFinal
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.SuspendableWriteChannel
awaitWritable, awaitWritable, close, flush, getWriteThread, isOpen, isWriteResumed, resumeWrites, shutdownWrites, suspendWrites, wakeupWrites
Methods inherited from interface java.nio.channels.WritableByteChannel
write
-
Method Details
-
getReadSetter
ChannelListener.Setter<? extends StreamChannel> getReadSetter()Get the setter which can be used to change the read listener for this channel.- Specified by:
getReadSetter
in interfaceStreamSourceChannel
- Specified by:
getReadSetter
in interfaceSuspendableChannel
- Specified by:
getReadSetter
in interfaceSuspendableReadChannel
- Returns:
- the setter
-
getWriteSetter
ChannelListener.Setter<? extends StreamChannel> getWriteSetter()Get the setter which can be used to change the write listener for this channel.- Specified by:
getWriteSetter
in interfaceStreamSinkChannel
- Specified by:
getWriteSetter
in interfaceSuspendableChannel
- Specified by:
getWriteSetter
in interfaceSuspendableWriteChannel
- 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 interfaceCloseableChannel
- Specified by:
getCloseSetter
in interfaceStreamSinkChannel
- Specified by:
getCloseSetter
in interfaceStreamSourceChannel
- Specified by:
getCloseSetter
in interfaceSuspendableChannel
- Specified by:
getCloseSetter
in interfaceSuspendableReadChannel
- Specified by:
getCloseSetter
in interfaceSuspendableWriteChannel
- Returns:
- the setter
-