Package org.elasticsearch.nio

Class SocketChannelContext

java.lang.Object

org.elasticsearch.nio.ChannelContext<SocketChannel>

org.elasticsearch.nio.SocketChannelContext

Direct Known Subclasses:

BytesChannelContext

public abstract class SocketChannelContext
extends ChannelContext<SocketChannel>

This context should implement the specific logic for a channel. When a channel receives a notification that it is ready to perform certain operations (read, write, etc) the SocketChannelContext will be called. This context will need to implement all protocol related logic. Additionally, if any special close behavior is required, it should be implemented in this context. The only methods of the context that should ever be called from a non-selector thread are ChannelContext.closeChannel() and sendMessage(Object, BiConsumer).

Field Summary

Fields

Modifier and Type	Field	Description
protected final NioSocketChannel	channel
protected final InboundChannelBuffer	channelBuffer
protected final AtomicBoolean	isClosing

Fields inherited from class org.elasticsearch.nio.ChannelContext

rawChannel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SocketChannelContext(NioSocketChannel channel, NioSelector selector, Config.Socket socketConfig, Consumer<Exception> exceptionHandler, NioChannelHandler channelHandler, InboundChannelBuffer channelBuffer)

Method Summary

Modifier and Type	Method	Description
void	addConnectListener(BiConsumer<Void,Exception> listener)
protected void	channelActive()
void	closeFromSelector()	This method cleans up any context resources that need to be released when a channel is closed.
protected boolean	closeNow()
boolean	connect()	This method will attempt to complete the connection process for this channel.
protected void	currentFlushOperationComplete()
protected void	currentFlushOperationFailed(IOException e)
abstract void	flushChannel()
protected int	flushToChannel(FlushOperation flushOperation)
NioSocketChannel	getChannel()
protected FlushOperation	getPendingFlush()
NioSelector	getSelector()
protected void	handleReadBytes()
boolean	isConnectComplete()
void	queueWriteOperation(WriteOperation writeOperation)
abstract int	read()
protected int	readFromChannel(InboundChannelBuffer inboundChannelBuffer)
boolean	readyForFlush()
protected void	register()
abstract boolean	selectorShouldClose()	This method indicates if a selector should close this channel.
void	sendMessage(Object message, BiConsumer<Void,Exception> listener)
protected void	setCloseNow()

Methods inherited from class org.elasticsearch.nio.ChannelContext

addCloseListener, closeChannel, getSelectionKey, handleException, isOpen, setSelectionKey

Methods inherited from class java.lang.Object

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

Field Details

channel

protected final NioSocketChannel channel

channelBuffer

protected final InboundChannelBuffer channelBuffer

isClosing

protected final AtomicBoolean isClosing

Constructor Details

SocketChannelContext

protected SocketChannelContext(NioSocketChannel channel,
 NioSelector selector,
 Config.Socket socketConfig,
 Consumer<Exception> exceptionHandler,
 NioChannelHandler channelHandler,
 InboundChannelBuffer channelBuffer)

Method Details

getSelector

public NioSelector getSelector()

Specified by:

getSelector in class ChannelContext<SocketChannel>

getChannel

public NioSocketChannel getChannel()

Specified by:

getChannel in class ChannelContext<SocketChannel>

register

protected void register()
                 throws IOException

Overrides:

register in class ChannelContext<SocketChannel>

Throws:

IOException

addConnectListener

public void addConnectListener(BiConsumer<Void,Exception> listener)

isConnectComplete

public boolean isConnectComplete()

connect

public boolean connect()
                throws IOException

This method will attempt to complete the connection process for this channel. It should be called for new channels or for a channel that has produced a OP_CONNECT event. If this method returns true then the connection is complete and the channel is ready for reads and writes. If it returns false, the channel is not yet connected and this method should be called again when a OP_CONNECT event is received.

Returns:

true if the connection process is complete

Throws:

IOException - if an I/O error occurs

sendMessage

public void sendMessage(Object message,
 BiConsumer<Void,Exception> listener)

queueWriteOperation

public void queueWriteOperation(WriteOperation writeOperation)

read

public abstract int read()
                  throws IOException

Throws:

IOException

flushChannel

public abstract void flushChannel()
                           throws IOException

Throws:

IOException

currentFlushOperationFailed

protected void currentFlushOperationFailed(IOException e)

currentFlushOperationComplete

protected void currentFlushOperationComplete()

getPendingFlush

protected FlushOperation getPendingFlush()

channelActive

protected void channelActive()
                      throws IOException

Overrides:

channelActive in class ChannelContext<SocketChannel>

Throws:

IOException

closeFromSelector

public void closeFromSelector()
                       throws IOException

Description copied from class: ChannelContext

This method cleans up any context resources that need to be released when a channel is closed. It should only be called by the selector thread.

Overrides:

closeFromSelector in class ChannelContext<SocketChannel>

Throws:

IOException - during channel / context close

handleReadBytes

protected void handleReadBytes()
                        throws IOException

Throws:

IOException

readyForFlush

public boolean readyForFlush()

selectorShouldClose

public abstract boolean selectorShouldClose()

This method indicates if a selector should close this channel.

Returns:

a boolean indicating if the selector should close

closeNow

protected boolean closeNow()

setCloseNow

protected void setCloseNow()

readFromChannel

protected int readFromChannel(InboundChannelBuffer inboundChannelBuffer)
                       throws IOException

Throws:

IOException

flushToChannel

protected int flushToChannel(FlushOperation flushOperation)
                      throws IOException

Throws:

IOException