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:

FramedMessageChannel

public interface MessageChannel
extends ReadableMessageChannel, WritableMessageChannel, SuspendableChannel

A channel that sends and receives whole messages.

Method Summary

Methods

Modifier and Type	Method and 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.ReadableMessageChannel

receive, receive, receive

Methods inherited from interface org.xnio.channels.WritableMessageChannel

send, send, send

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, isWriteResumed, resumeWrites, shutdownWrites, suspendWrites, wakeupWrites

Methods inherited from interface org.xnio.channels.CloseableChannel

getWorker

Methods inherited from interface java.nio.channels.Channel

isOpen

Methods inherited from interface org.xnio.channels.Configurable

getOption, setOption, supportsOption

Method Detail

getReadSetter

ChannelListener.Setter<? extends MessageChannel> 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 ReadableMessageChannel

Specified by:

getReadSetter in interface SuspendableChannel

Specified by:

getReadSetter in interface SuspendableReadChannel

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 interface CloseableChannel

Specified by:

getCloseSetter in interface ReadableMessageChannel

Specified by:

getCloseSetter in interface SuspendableChannel

Specified by:

getCloseSetter in interface SuspendableReadChannel

Specified by:

getCloseSetter in interface SuspendableWriteChannel

Specified by:

getCloseSetter in interface WritableMessageChannel

Returns:

the setter

getWriteSetter

ChannelListener.Setter<? extends MessageChannel> 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 SuspendableChannel

Specified by:

getWriteSetter in interface SuspendableWriteChannel

Specified by:

getWriteSetter in interface WritableMessageChannel

Returns:

the setter