org.tools4j.nobark.queue

Interface ExchangeConflationQueue.ExchangePoller<K,V>

Type Parameters:

K - the type of the conflation key

V - the type of values in the queue

All Superinterfaces:

ConflationQueue.Poller<K,V>

Enclosing interface:

ExchangeConflationQueue<K,V>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface ExchangeConflationQueue.ExchangePoller<K,V>
extends ConflationQueue.Poller<K,V>

Poller object used by the consumer to poll values; exchange poller adds functionality for exchanging values with the producer during poll operations.

Method Summary

Modifier and Type	Method and Description
default V	poll(java.util.function.BiConsumer<? super K,? super V> consumer) Polls the queue passing a consumer which is invoked with conflation key and polled value if the queue was non-empty.
V	poll(java.util.function.BiConsumer<? super K,? super V> consumer, V exchange) Polls the queue passing an unused value in exchange to the queue.
default V	poll(V exchange) Polls the queue passing an unused value in exchange to the queue.

Methods inherited from interface org.tools4j.nobark.queue.ConflationQueue.Poller

poll

Method Detail

poll

V poll(java.util.function.BiConsumer<? super K,? super V> consumer,
       V exchange)

Polls the queue passing an unused value in exchange to the queue. The given consumer is invoked with conflation key and polled value if the queue was non-empty and the value is returned. If the queue was empty, null is returned.

If polling was successful, the exchange value will at some point be returned by an enqueue operation with the same conflation key and can be reused by the producer. The caller retains ownership of the exchange value if polling failed and null was returned.

Parameters:

consumer - consumer for conflation key and polled value

exchange - a value offered in exchange for the polled value, to be returned by an enqueue operation

Returns:

the polled value, or null if the queue was empty

poll

default V poll(V exchange)

Polls the queue passing an unused value in exchange to the queue. Returns the polled value if any value was present in the queue, or null if the queue was empty.

If polling was successful, the exchange value will at some point be returned by an enqueue operation with the same conflation key and can be reused by the producer. The caller retains ownership of the exchange value if polling failed and null was returned.

Parameters:

exchange - a value offered in exchange for the polled value, to be returned by an enqueue operation

Returns:

the polled value, or null if the queue was empty

poll

default V poll(java.util.function.BiConsumer<? super K,? super V> consumer)

Description copied from interface: ConflationQueue.Poller

Polls the queue passing a consumer which is invoked with conflation key and polled value if the queue was non-empty. Returns the polled value if any value was present in the queue, or null if the queue was empty.

Specified by:

poll in interface ConflationQueue.Poller<K,V>

Parameters:

consumer - consumer for conflation key and polled value

Returns:

the polled value, or null if the queue was empty