com.mapr.ojai.store.impl

Class BlockingHandoff<T>

java.lang.Object

com.mapr.ojai.store.impl.BlockingHandoff<T>

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<T>

public abstract class BlockingHandoff<T>
extends java.lang.Object
implements java.lang.Iterable<T>, java.lang.AutoCloseable

Constructor Summary

Constructors

Constructor and Description
BlockingHandoff(T endSentinel, long timeoutMs) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract void	itemTimeout(long timeoutMs) Inform the derived class that we timed-out while waiting for an item This function must not return (i.e., you must throw an exception)
java.util.Iterator<T>	iterator()
protected abstract void	iteratorTimeout()
boolean	put(T item) Put an item into the handoff for consumption.
void	putEos() Indicate that there are no more items.
void	putException(java.lang.Exception ex)
protected abstract void	setup(java.util.concurrent.CountDownLatch readyLatch)
protected void	throwQueryTimeout() Throw a QueryTimeoutException.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

BlockingHandoff

public BlockingHandoff(T endSentinel,
                       long timeoutMs)

Constructor.

Parameters:

-

timeoutMs - the maximum amount of time that can pass when waiting for an item from the iterator.

Method Detail

throwQueryTimeout

protected void throwQueryTimeout()

Throw a QueryTimeoutException. Does not return.

itemTimeout

protected abstract void itemTimeout(long timeoutMs)

Inform the derived class that we timed-out while waiting for an item This function must not return (i.e., you must throw an exception)

Parameters:

timeoutMs - how long the timeout was

put

public boolean put(T item)

Put an item into the handoff for consumption. If the last item has not yet been consumed (via the iterator), then this will first block until the previous item is consumed.

Parameters:

item - the new item

putException

public void putException(java.lang.Exception ex)

putEos

public void putEos()

Indicate that there are no more items. If the last item has not yet been consumed (via the iterator), then this will first block until the previous item is consumed.

setup

protected abstract void setup(java.util.concurrent.CountDownLatch readyLatch)

iteratorTimeout

protected abstract void iteratorTimeout()

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable