-
- All Superinterfaces:
java.lang.AutoCloseable
,java.nio.channels.Channel
,java.io.Closeable
,CloseableChannel
,Configurable
,java.nio.channels.InterruptibleChannel
,ReadableMessageChannel
,SuspendableChannel
,SuspendableReadChannel
,SuspendableWriteChannel
,WritableMessageChannel
- All Known Subinterfaces:
ConnectedMessageChannel
- All Known Implementing Classes:
AssembledConnectedMessageChannel
,AssembledMessageChannel
,FramedMessageChannel
public interface MessageChannel extends ReadableMessageChannel, WritableMessageChannel, SuspendableChannel
A channel that sends and receives whole messages.
-
-
Field Summary
-
Fields inherited from interface org.xnio.channels.Configurable
EMPTY
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ChannelListener.Setter<? extends MessageChannel>
getCloseSetter()
Get the setter which can be used to change the close listener for this channel.ChannelListener.Setter<? extends MessageChannel>
getReadSetter()
Get the setter which can be used to change the read listener for this channel.ChannelListener.Setter<? extends MessageChannel>
getWriteSetter()
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 org.xnio.channels.ReadableMessageChannel
receive, receive, receive
-
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
-
-
-
-
Method Detail
-
getReadSetter
ChannelListener.Setter<? extends MessageChannel> getReadSetter()
Get the setter which can be used to change the read listener for this channel.- Specified by:
getReadSetter
in interfaceReadableMessageChannel
- Specified by:
getReadSetter
in interfaceSuspendableChannel
- Specified by:
getReadSetter
in interfaceSuspendableReadChannel
- Returns:
- the setter
-
getCloseSetter
ChannelListener.Setter<? extends MessageChannel> 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 interfaceReadableMessageChannel
- Specified by:
getCloseSetter
in interfaceSuspendableChannel
- Specified by:
getCloseSetter
in interfaceSuspendableReadChannel
- Specified by:
getCloseSetter
in interfaceSuspendableWriteChannel
- Specified by:
getCloseSetter
in interfaceWritableMessageChannel
- Returns:
- the setter
-
getWriteSetter
ChannelListener.Setter<? extends MessageChannel> getWriteSetter()
Get the setter which can be used to change the write listener for this channel.- Specified by:
getWriteSetter
in interfaceSuspendableChannel
- Specified by:
getWriteSetter
in interfaceSuspendableWriteChannel
- Specified by:
getWriteSetter
in interfaceWritableMessageChannel
- Returns:
- the setter
-
-