org.xnio.channels

Interface CloseableChannel

All Superinterfaces:

AutoCloseable, Channel, Closeable, Configurable, InterruptibleChannel

All Known Subinterfaces:

AcceptingChannel<C>, BoundChannel, BoundMultipointMessageChannel, ConnectedChannel, ConnectedMessageChannel, ConnectedSslStreamChannel, ConnectedStreamChannel, MessageChannel, MulticastMessageChannel, MultipointMessageChannel, ReadableMessageChannel, ReadableMultipointMessageChannel, SimpleAcceptingChannel<C>, SslChannel, StreamChannel, StreamSinkChannel, StreamSourceChannel, SuspendableAcceptChannel, SuspendableChannel, SuspendableReadChannel, SuspendableWriteChannel, WritableMessageChannel, WritableMultipointMessageChannel

All Known Implementing Classes:

AbstractAjpClientStreamSinkChannel, AbstractAjpClientStreamSourceChannel, AbstractFramedChannel, AbstractFramedStreamSinkChannel, AbstractFramedStreamSourceChannel, AbstractHttp2StreamSinkChannel, AbstractHttp2StreamSourceChannel, AbstractServerConnection, AjpClientChannel, AjpClientRequestClientStreamSinkChannel, AjpClientResponseStreamSourceChannel, AjpServerConnection, AssembledChannel, AssembledConnectedChannel, AssembledConnectedMessageChannel, AssembledConnectedSslStreamChannel, AssembledConnectedStreamChannel, AssembledMessageChannel, AssembledSslChannel, AssembledStreamChannel, ChannelFunctionStreamSourceChannel, ConduitReadableMessageChannel, ConduitStreamSinkChannel, ConduitStreamSourceChannel, ConduitWritableMessageChannel, Connection, DetachableStreamSinkChannel, DetachableStreamSourceChannel, EmptyStreamSourceChannel, FixedLengthStreamSinkChannel, FixedLengthStreamSourceChannel, FramedMessageChannel, Http2Channel, Http2DataStreamSinkChannel, Http2GoAwayStreamSourceChannel, Http2HeadersStreamSinkChannel, Http2PingStreamSourceChannel, Http2PushPromiseStreamSinkChannel, Http2PushPromiseStreamSourceChannel, Http2RstStreamStreamSourceChannel, Http2ServerConnection, Http2SettingsStreamSinkChannel, Http2SettingsStreamSourceChannel, Http2StreamSinkChannel, Http2StreamSourceChannel, HttpServerConnection, JsseSslConnection, JsseSslStreamConnection, MessageConnection, NullStreamSinkChannel, PushBackStreamChannel, ServerConnection, SplitStreamSinkChannel, SplitStreamSourceChannel, SslConnection, StreamConnection, StreamSinkFrameChannel, StreamSourceFrameChannel, TranslatingSuspendableChannel, WebSocket07Channel, WebSocket07FrameSinkChannel, WebSocket08Channel, WebSocket13Channel, WebSocketChannel

public interface CloseableChannel
extends InterruptibleChannel, Configurable

A channel which is closeable. A listener may be registered which is triggered (only once) on channel close.

Since:

2.0

Field Summary

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Method Summary

Modifier and Type	Method and Description
void	close() Close this channel.
ChannelListener.Setter<? extends CloseableChannel>	getCloseSetter() Get the setter which can be used to change the close listener for this channel.
XnioIoThread	getIoThread() Get the I/O thread associated with this channel.
XnioWorker	getWorker() Get the worker for this channel.

Methods inherited from interface java.nio.channels.Channel

isOpen

Methods inherited from interface org.xnio.channels.Configurable

getOption, setOption, supportsOption

Method Detail

getCloseSetter

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

Returns:

the setter

getWorker

XnioWorker getWorker()

Get the worker for this channel.

Returns:

the worker

getIoThread

XnioIoThread getIoThread()

Get the I/O thread associated with this channel.

Returns:

the I/O thread associated with this channel

close

void close()
    throws IOException

Close this channel. When a channel is closed, its close listener is invoked. Invoking this method more than once has no additional effect.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface Closeable

Specified by:

close in interface InterruptibleChannel

Throws:

IOException - if the close failed