Package org.elasticsearch.transport.nio.channel

Class AbstractNioChannel<S extends java.nio.channels.SelectableChannel & java.nio.channels.NetworkChannel>

java.lang.Object

org.elasticsearch.transport.nio.channel.AbstractNioChannel<S>

Type Parameters:

S - the type of raw channel this AbstractNioChannel uses

All Implemented Interfaces:

NioChannel

Direct Known Subclasses:

NioServerSocketChannel, NioSocketChannel

public abstract class AbstractNioChannel<S extends java.nio.channels.SelectableChannel & java.nio.channels.NetworkChannel>
extends java.lang.Object
implements NioChannel

This is a basic channel abstraction used by the NioTransport.

A channel is open once it is constructed. The channel remains open and isOpen() will return true until the channel is explicitly closed.

A channel lifecycle has two stages:

1. OPEN - When a channel has been created. This is the state of a channel that can perform normal operations.
2. CLOSED - The channel has been set to closed. All this means is that the channel has been scheduled to be closed. The underlying raw channel may not yet be closed. The underlying channel has been closed if the close future has been completed.

Method Summary

Modifier and Type	Method	Description
void	addCloseListener(ActionListener<java.lang.Void> listener)	Adds a close listener to the channel.
void	close()	Schedules a channel to be closed by the selector event loop with which it is registered.
void	closeFromSelector()	Closes the channel synchronously.
java.net.InetSocketAddress	getLocalAddress()
S	getRawChannel()
java.nio.channels.SelectionKey	getSelectionKey()
ESSelector	getSelector()
boolean	isOpen()
void	register()	This method attempts to registered a channel with the raw nio selector.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isOpen

public boolean isOpen()

Specified by:

isOpen in interface NioChannel

getLocalAddress

public java.net.InetSocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface NioChannel

close

public void close()

Schedules a channel to be closed by the selector event loop with which it is registered.

If the channel is open and the state can be transitioned to closed, the close operation will be scheduled with the event loop.

If the channel is already set to closed, it is assumed that it is already scheduled to be closed.

Specified by:

close in interface NioChannel

closeFromSelector

public void closeFromSelector()
                       throws java.io.IOException

Closes the channel synchronously. This method should only be called from the selector thread.

Once this method returns, the channel will be closed.

Specified by:

closeFromSelector in interface NioChannel

Throws:

java.io.IOException

register

public void register()
              throws java.nio.channels.ClosedChannelException

This method attempts to registered a channel with the raw nio selector. It also sets the selection key.

Specified by:

register in interface NioChannel

Throws:

java.nio.channels.ClosedChannelException - if the raw channel was closed

getSelector

public ESSelector getSelector()

Specified by:

getSelector in interface NioChannel

getSelectionKey

public java.nio.channels.SelectionKey getSelectionKey()

Specified by:

getSelectionKey in interface NioChannel

getRawChannel

public S getRawChannel()

Specified by:

getRawChannel in interface NioChannel

addCloseListener

public void addCloseListener(ActionListener<java.lang.Void> listener)

Description copied from interface: NioChannel

Adds a close listener to the channel. Multiple close listeners can be added. There is no guarantee about the order in which close listeners will be executed. If the channel is already closed, the listener is executed immediately.

Specified by:

addCloseListener in interface NioChannel

Parameters:

listener - to be called at close