Package org.apache.nifi.processors.standard

Class WaitNotifyProtocol.Signal

java.lang.Object

org.apache.nifi.processors.standard.WaitNotifyProtocol.Signal

Enclosing class:

WaitNotifyProtocol

public static class WaitNotifyProtocol.Signal
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,String>	attributes
private AtomicCacheEntry<String,String,Object>	cachedEntry
private Map<String,Long>	counts
private String	identifier
private long	releasableCount

Constructor Summary

Constructors

Constructor	Description
Signal()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAttributes()
long	getCount(String counterName)
Map<String,Long>	getCounts()
long	getReleasableCount()
long	getTotalCount()
boolean	isCountReached(String counterName, long targetCount)
boolean	isTotalCountReached(long targetCount)
<E> void	releaseCandidates(String counterName, long requiredCountForPass, int releasableCandidateCountPerPass, List<E> candidates, Consumer<List<E>> released, Consumer<List<E>> waiting)	Consume accumulated notification signals to let some waiting candidates get released.
void	setAttributes(Map<String,String> attributes)
void	setCounts(Map<String,Long> counts)
void	setReleasableCount(long releasableCount)

Methods inherited from class java.lang.Object

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

Field Details

identifier

private transient String identifier

cachedEntry

private transient AtomicCacheEntry<String,String,Object> cachedEntry

counts

private Map<String,Long> counts

attributes

private Map<String,String> attributes

releasableCount

private long releasableCount

Constructor Details

Signal

public Signal()

Method Details

getCounts

public Map<String,Long> getCounts()

setCounts

public void setCounts(Map<String,Long> counts)

getAttributes

public Map<String,String> getAttributes()

setAttributes

public void setAttributes(Map<String,String> attributes)

getTotalCount

public long getTotalCount()

isTotalCountReached

public boolean isTotalCountReached(long targetCount)

isCountReached

public boolean isCountReached(String counterName,
 long targetCount)

getCount

public long getCount(String counterName)

getReleasableCount

public long getReleasableCount()

setReleasableCount

public void setReleasableCount(long releasableCount)

releaseCandidates

public <E> void releaseCandidates(String counterName,
 long requiredCountForPass,
 int releasableCandidateCountPerPass,
 List<E> candidates,
 Consumer<List<E>> released,
 Consumer<List<E>> waiting)

Consume accumulated notification signals to let some waiting candidates get released.

This method updates state of this instance, but does not update cache storage. Caller of this method is responsible for updating cache storage after processing released and waiting candidates by calling WaitNotifyProtocol.replace(Signal). Caller should rollback what it processed with these candidates if complete call failed.

Type Parameters:

E - Type of candidate

Parameters:

counterName - signal counter name to consume from. If not specified, total counter is used, and 'consumed' counter is added to subtract consumed counters from total counter.

requiredCountForPass - number of required signals to acquire a pass.

releasableCandidateCountPerPass - number of releasable candidate per pass.

candidates - candidates waiting for being allowed to pass.

released - function to process allowed candidates to pass.

waiting - function to process candidates those should remain in waiting queue.