org.apache.nifi.io.nio

Class AbstractChannelReader

java.lang.Object

org.apache.nifi.io.nio.AbstractChannelReader

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

DatagramChannelReader, SocketChannelReader

public abstract class AbstractChannelReader
extends Object
implements Runnable

Field Summary

Fields

Modifier and Type	Field and Description
private BufferPool	bufferPool
private StreamConsumer	consumer
private AtomicReference<ScheduledFuture<?>>	future
private AtomicBoolean	isClosed
private SelectionKey	key
private static org.slf4j.Logger	LOGGER
private String	uniqueId

Constructor Summary

Constructors

Constructor and Description
AbstractChannelReader(String id, SelectionKey key, BufferPool empties, StreamConsumerFactory consumerFactory)

Method Summary

Modifier and Type	Method and Description
private void	closeStream()
boolean	equals(Object obj)
protected abstract int	fillBuffer(SelectionKey key, ByteBuffer buffer) Allows a subclass to specifically handle how it reads from the given key's channel into the given buffer.
protected ScheduledFuture<?>	getScheduledFuture()
protected SelectionKey	getSelectionKey()
int	hashCode()
boolean	isClosed()
void	run()
protected void	setScheduledFuture(ScheduledFuture<?> future)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

uniqueId

private final String uniqueId

key

private final SelectionKey key

bufferPool

private final BufferPool bufferPool

consumer

private final StreamConsumer consumer

isClosed

private final AtomicBoolean isClosed

future

private final AtomicReference<ScheduledFuture<?>> future

Constructor Detail

AbstractChannelReader

public AbstractChannelReader(String id,
                             SelectionKey key,
                             BufferPool empties,
                             StreamConsumerFactory consumerFactory)

Method Detail

setScheduledFuture

protected void setScheduledFuture(ScheduledFuture<?> future)

getScheduledFuture

protected ScheduledFuture<?> getScheduledFuture()

getSelectionKey

protected SelectionKey getSelectionKey()

isClosed

public boolean isClosed()

closeStream

private void closeStream()

fillBuffer

protected abstract int fillBuffer(SelectionKey key,
                                  ByteBuffer buffer)
                           throws IOException

Allows a subclass to specifically handle how it reads from the given key's channel into the given buffer.

Parameters:

key - of channel to read from

buffer - to fill

Returns:

the number of bytes read in the final read cycle. A value of zero or more indicates the channel is still open but a value of -1 indicates end of stream.

Throws:

IOException - if reading from channel causes failure

run

public final void run()

Specified by:

run in interface Runnable

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object