Package org.xnio.channels
Interface MessageChannel
- All Superinterfaces:
AutoCloseable,Channel,Closeable,CloseableChannel,Configurable,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
Modifier and TypeMethodDescriptionChannelListener.Setter<? extends MessageChannel>Get the setter which can be used to change the close listener for this channel.ChannelListener.Setter<? extends MessageChannel>Get the setter which can be used to change the read listener for this channel.ChannelListener.Setter<? extends MessageChannel>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 org.xnio.channels.ReadableMessageChannel
receive, receive, receiveMethods 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, wakeupWrites
-
Method Details
-
getReadSetter
ChannelListener.Setter<? extends MessageChannel> getReadSetter()Get the setter which can be used to change the read listener for this channel.- Specified by:
getReadSetterin interfaceReadableMessageChannel- Specified by:
getReadSetterin interfaceSuspendableChannel- Specified by:
getReadSetterin 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:
getCloseSetterin interfaceCloseableChannel- Specified by:
getCloseSetterin interfaceReadableMessageChannel- Specified by:
getCloseSetterin interfaceSuspendableChannel- Specified by:
getCloseSetterin interfaceSuspendableReadChannel- Specified by:
getCloseSetterin interfaceSuspendableWriteChannel- Specified by:
getCloseSetterin 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:
getWriteSetterin interfaceSuspendableChannel- Specified by:
getWriteSetterin interfaceSuspendableWriteChannel- Specified by:
getWriteSetterin interfaceWritableMessageChannel- Returns:
- the setter
-