io.siddhi.core.query.output.ratelimit

Class OutputRateLimiter

java.lang.Object

io.siddhi.core.query.output.ratelimit.OutputRateLimiter

All Implemented Interfaces:

EternalReferencedHolder, Snapshotable

Direct Known Subclasses:

AllPerEventOutputRateLimiter, AllPerTimeOutputRateLimiter, FirstGroupByPerEventOutputRateLimiter, FirstGroupByPerTimeOutputRateLimiter, FirstPerEventOutputRateLimiter, FirstPerTimeOutputRateLimiter, LastGroupByPerEventOutputRateLimiter, LastGroupByPerTimeOutputRateLimiter, LastPerEventOutputRateLimiter, LastPerTimeOutputRateLimiter, PassThroughOutputRateLimiter, WrappedSnapshotOutputRateLimiter

public abstract class OutputRateLimiter
extends Object
implements EternalReferencedHolder, Snapshotable

Abstract parent implementation of Output Rate Limiting. Output Rate Limiting is used to throttle the output of Siddhi queries based on various criteria.

Field Summary

Fields

Modifier and Type	Field and Description
protected LatencyTracker	latencyTracker
protected LockWrapper	lockWrapper
protected OutputCallback	outputCallback
protected List<QueryCallback>	queryCallbacks
protected SiddhiQueryContext	siddhiQueryContext

Constructor Summary

Constructors

Constructor and Description
OutputRateLimiter()

Method Summary

Modifier and Type	Method and Description
void	addQueryCallback(QueryCallback callback)
void	clean() Used to clean its references
abstract OutputRateLimiter	clone(String key)
String	getElementId()
OutputCallback	getOutputCallback()
boolean	hasCallBack()
void	init(LockWrapper lockWrapper, SiddhiQueryContext siddhiQueryContext)
abstract void	process(ComplexEventChunk complexEventChunk)
void	sendToCallBacks(ComplexEventChunk complexEventChunk)
void	setLatencyTracker(LatencyTracker latencyTracker)
void	setOutputCallback(OutputCallback outputCallback)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.siddhi.core.util.extension.holder.EternalReferencedHolder

start, stop

Methods inherited from interface io.siddhi.core.util.snapshot.Snapshotable

currentState, restoreState

Field Detail

queryCallbacks

protected List<QueryCallback> queryCallbacks

outputCallback

protected OutputCallback outputCallback

latencyTracker

protected LatencyTracker latencyTracker

siddhiQueryContext

protected SiddhiQueryContext siddhiQueryContext

lockWrapper

protected LockWrapper lockWrapper

Constructor Detail

OutputRateLimiter

public OutputRateLimiter()

Method Detail

init

public void init(LockWrapper lockWrapper,
                 SiddhiQueryContext siddhiQueryContext)

sendToCallBacks

public void sendToCallBacks(ComplexEventChunk complexEventChunk)

addQueryCallback

public void addQueryCallback(QueryCallback callback)

process

public abstract void process(ComplexEventChunk complexEventChunk)

getOutputCallback

public OutputCallback getOutputCallback()

setOutputCallback

public void setOutputCallback(OutputCallback outputCallback)

hasCallBack

public boolean hasCallBack()

clone

public abstract OutputRateLimiter clone(String key)

getElementId

public String getElementId()

Specified by:

getElementId in interface Snapshotable

setLatencyTracker

public void setLatencyTracker(LatencyTracker latencyTracker)

clean

public void clean()

Description copied from interface: Snapshotable

Used to clean its references

Specified by:

clean in interface Snapshotable