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, getWorkerMethods inherited from interface org.xnio.channels.Configurable
getOption, setOption, supportsOptionMethods inherited from interface java.nio.channels.GatheringByteChannel
write, writeMethods inherited from interface java.nio.channels.ReadableByteChannel
readMethods inherited from interface java.nio.channels.ScatteringByteChannel
read, readMethods inherited from interface org.xnio.channels.StreamSinkChannel
transferFrom, transferFrom, writeFinal, writeFinal, writeFinalMethods inherited from interface org.xnio.channels.StreamSourceChannel
transferTo, transferToMethods inherited from interface org.xnio.channels.SuspendableReadChannel
awaitReadable, awaitReadable, getReadThread, isReadResumed, resumeReads, shutdownReads, suspendReads, wakeupReadsMethods inherited from interface org.xnio.channels.SuspendableWriteChannel
awaitWritable, awaitWritable, close, flush, getWriteThread, isOpen, isWriteResumed, resumeWrites, shutdownWrites, suspendWrites, wakeupWritesMethods 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:
getReadSetterin interfaceStreamSourceChannel- Specified by:
getReadSetterin interfaceSuspendableChannel- Specified by:
getReadSetterin 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:
getWriteSetterin interfaceStreamSinkChannel- Specified by:
getWriteSetterin interfaceSuspendableChannel- Specified by:
getWriteSetterin 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:
getCloseSetterin interfaceCloseableChannel- Specified by:
getCloseSetterin interfaceStreamSinkChannel- Specified by:
getCloseSetterin interfaceStreamSourceChannel- Specified by:
getCloseSetterin interfaceSuspendableChannel- Specified by:
getCloseSetterin interfaceSuspendableReadChannel- Specified by:
getCloseSetterin interfaceSuspendableWriteChannel- Returns:
- the setter
-