org.refcodes.io

Class AbstractPrefetchInputStreamByteReceiver

java.lang.Object

org.refcodes.io.AbstractByteProvider

org.refcodes.io.AbstractByteReceiver

org.refcodes.io.AbstractPrefetchInputStreamByteReceiver

All Implemented Interfaces:

org.refcodes.component.Closable, org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.ClosedAccessor, org.refcodes.component.ConnectableComponent, org.refcodes.component.ConnectableComponent.ConnectableAutomaton, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.OpenedAccessor, ByteBlockProvider, ByteBlockReceiver, ByteDatagramProvider, ByteDatagramReceiver, ByteProvider, ByteReceiver, Receivable, org.refcodes.mixin.Releaseable

Direct Known Subclasses:

PrefetchBidirectionalStreamConnectionByteTransceiverImpl, PrefetchInputStreamConnectionByteReceiverImpl

public abstract class AbstractPrefetchInputStreamByteReceiver
extends AbstractByteReceiver

Abstract implementation of the ByteReceiver interface. As of the prefetching functionality, a separate daemon thread (retrieved via an ExecutorService) reads from the provided InputStream and places the datagrams into a datagram queue until the datagram queue's capacity is reached. Datagrams are read by the AbstractByteReceiver.readDatagram() (AbstractByteReceiver.readDatagrams()) by them methods popping the datagrams from the datagram queue. If the queue is empty, then the AbstractByteReceiver.readDatagram() ( AbstractByteReceiver.readDatagrams()) method is blocked until the daemon thread places new datagrams into the queue.

See Also:

AbstractByteReceiver

Nested Class Summary

Nested classes/interfaces inherited from class org.refcodes.io.AbstractByteReceiver

AbstractByteReceiver.ConnectableAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.OpenedAccessor

org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Closable

org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ClosedAccessor

org.refcodes.component.ClosedAccessor.ClosedMutator, org.refcodes.component.ClosedAccessor.ClosedProperty

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionStatusAccessor

org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty

Field Summary

Fields inherited from class org.refcodes.io.AbstractByteReceiver

_automaton

Fields inherited from class org.refcodes.io.AbstractByteProvider

_datagramQueue, DATAGRAM_QUEUE_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractPrefetchInputStreamByteReceiver() Creates an AbstractPrefetchInputStreamByteReceiver.
AbstractPrefetchInputStreamByteReceiver(ExecutorService aExecutorService) Creates an AbstractPrefetchInputStreamByteReceiver using the given ExecutorService required for thread generation in an JEE environment.
AbstractPrefetchInputStreamByteReceiver(int aQueueCapacity) Creates an AbstractPrefetchInputStreamByteReceiver using the given datagram queue capacity.
AbstractPrefetchInputStreamByteReceiver(int aQueueCapacity, ExecutorService aExecutorService) Creates an AbstractPrefetchInputStreamByteReceiver using the given ExecutorService required for thread generation in an JEE environment.

Method Summary

Modifier and Type	Method and Description
void	close()
protected boolean	isOpenable(InputStream aInputStream) Checks if is openable.
protected void	open(InputStream aInputStream) Open, see also ConnectionOpenable.open(Object).

Methods inherited from class org.refcodes.io.AbstractByteReceiver

getConnectionStatus, hasDatagram, isClosable, isClosed, isOpenable, isOpened, open, readDatagram, readDatagrams, readDatagrams, releaseAll, setConnectionStatus

Methods inherited from class org.refcodes.io.AbstractByteProvider

pushDatagram, pushDatagrams, pushDatagrams

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

isConnectionOpened

Constructor Detail

AbstractPrefetchInputStreamByteReceiver

public AbstractPrefetchInputStreamByteReceiver()

Creates an AbstractPrefetchInputStreamByteReceiver.

AbstractPrefetchInputStreamByteReceiver

public AbstractPrefetchInputStreamByteReceiver(ExecutorService aExecutorService)

Creates an AbstractPrefetchInputStreamByteReceiver using the given ExecutorService required for thread generation in an JEE environment.

Parameters:

aExecutorService - The ExecutorService to be used, when null then an ExecutorService something line Executors.newCachedThreadPool() is then retrieved.

AbstractPrefetchInputStreamByteReceiver

public AbstractPrefetchInputStreamByteReceiver(int aQueueCapacity)

Creates an AbstractPrefetchInputStreamByteReceiver using the given datagram queue capacity.

Parameters:

aQueueCapacity - The capacity of the prefetch queue before it blocks until data is read via AbstractByteReceiver.readDatagram() ( AbstractByteReceiver.readDatagrams()).

AbstractPrefetchInputStreamByteReceiver

public AbstractPrefetchInputStreamByteReceiver(int aQueueCapacity,
                                               ExecutorService aExecutorService)

Creates an AbstractPrefetchInputStreamByteReceiver using the given ExecutorService required for thread generation in an JEE environment.

Parameters:

aQueueCapacity - The capacity of the prefetch queue before it blocks until data is read via AbstractByteReceiver.readDatagram() ( AbstractByteReceiver.readDatagrams()).

aExecutorService - The ExecutorService to be used, when null then an ExecutorService something line Executors.newCachedThreadPool() is then retrieved.

Method Detail

close

public void close()
           throws org.refcodes.component.CloseException

Specified by:

close in interface org.refcodes.component.Closable

Overrides:

close in class AbstractByteReceiver

Throws:

org.refcodes.component.CloseException

open

protected void open(InputStream aInputStream)
             throws org.refcodes.component.OpenException

Open, see also ConnectionOpenable.open(Object).

Parameters:

aInputStream - the input stream

Throws:

org.refcodes.component.OpenException - the open exception

isOpenable

protected boolean isOpenable(InputStream aInputStream)

Checks if is openable. See also ConnectionOpenable.ConnectionOpenAutomaton.isOpenable(Object).

Parameters:

aInputStream - the input stream

Returns:

true, if is openable