org.wso2.siddhi.core.util.timestamp

Class EventTimeBasedMillisTimestampGenerator

java.lang.Object

org.wso2.siddhi.core.util.timestamp.EventTimeBasedMillisTimestampGenerator

All Implemented Interfaces:

TimestampGenerator

public class EventTimeBasedMillisTimestampGenerator
extends Object
implements TimestampGenerator

Return the timestamp of the latest event received by the stream junction. This generator can notify the Scheduler whenever there is a new event with increased timestamp. Also it can optionally send heart beat to the registered schedulers based on the configuration provided.

See Also:

StreamJunction.sendData(long, Object[])

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EventTimeBasedMillisTimestampGenerator.TimeChangeListener Listener used to get notification when a new event comes in.

Constructor Summary

Constructors

Constructor and Description
EventTimeBasedMillisTimestampGenerator(ScheduledExecutorService scheduledExecutorService) Create an EventBasedTimeMillisTimestampGenerator.

Method Summary

Modifier and Type	Method and Description
void	addTimeChangeListener(EventTimeBasedMillisTimestampGenerator.TimeChangeListener listener) Register to listen for time changes.
long	currentTime() Return the time of last event received by Siddhi or the time generated by internal clock after a delay as defined in Playback annotation.
void	setCurrentTimestamp(long timestamp) Set the timestamp to the EventTimeBasedMillisTimestampGenerator and notify the interested listeners.
void	setIdleTime(long idleTime) The ScheduledExecutorService waits until idleTime from the timestamp of last event and if there are no new events arrived within that period, it will inject a new timestamp.
void	setIncrementInMilliseconds(long incrementInMilliseconds) Set by how many milliseconds, the event timestamp should be increased.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventTimeBasedMillisTimestampGenerator

public EventTimeBasedMillisTimestampGenerator(ScheduledExecutorService scheduledExecutorService)

Create an EventBasedTimeMillisTimestampGenerator.

Parameters:

scheduledExecutorService - the schedule service to be executed for produce heartbeat.

Method Detail

currentTime

public long currentTime()

Return the time of last event received by Siddhi or the time generated by internal clock after a delay as defined in Playback annotation.

Specified by:

currentTime in interface TimestampGenerator

Returns:

timestamp

setCurrentTimestamp

public void setCurrentTimestamp(long timestamp)

Set the timestamp to the EventTimeBasedMillisTimestampGenerator and notify the interested listeners.

Parameters:

timestamp - the timestamp to the EventTimeBasedMillisTimestampGenerator

addTimeChangeListener

public void addTimeChangeListener(EventTimeBasedMillisTimestampGenerator.TimeChangeListener listener)

Register to listen for time changes.

Parameters:

listener - any listeners interested on time change.

See Also:

Scheduler

setIdleTime

public void setIdleTime(long idleTime)

The ScheduledExecutorService waits until idleTime from the timestamp of last event and if there are no new events arrived within that period, it will inject a new timestamp.

Parameters:

idleTime - the ideal time for wait until from the timestamp of last event.

setIncrementInMilliseconds

public void setIncrementInMilliseconds(long incrementInMilliseconds)

Set by how many milliseconds, the event timestamp should be increased.

Parameters:

incrementInMilliseconds - the timestamp incremental value.