com.serotonin.mango.rt.event.detectors

Class TimeoutDetectorRT

java.lang.Object

com.serotonin.mango.rt.event.SimpleEventDetector

com.serotonin.mango.rt.event.detectors.PointEventDetectorRT

com.serotonin.mango.rt.event.detectors.TimeoutDetectorRT

All Implemented Interfaces:

DataPointListener, EventDetector, TimeoutClient, com.serotonin.util.ILifecycle

Direct Known Subclasses:

StateChangeCountDetectorRT, TimeDelayedEventDetectorRT

public abstract class TimeoutDetectorRT
extends PointEventDetectorRT
implements TimeoutClient

This class is a base class for detectors that need to schedule timeouts for their operation. Subclasses may use schedules for timeouts that make them active, or that make them inactive.

Author:

Matthew Lohbihler

Field Summary

Fields

Modifier and Type	Field and Description
private com.serotonin.web.i18n.LocalizableMessage	durationDescription Internal configuration field.
private long	durationMS Internal configuration field.
private com.serotonin.timer.TimerTask	task Internal configuration field.

Fields inherited from class com.serotonin.mango.rt.event.detectors.PointEventDetectorRT

vo

Constructor Summary

Constructors

Constructor and Description
TimeoutDetectorRT()

Method Summary

Modifier and Type	Method and Description
private void	cancelTask()
protected com.serotonin.web.i18n.LocalizableMessage	getDurationDescription()
protected long	getDurationMS()
void	initialize()
protected boolean	isJobScheduled()
protected void	scheduleJob(long timeout)
void	scheduleTimeout(long fireTime)
protected abstract void	scheduleTimeoutImpl(long fireTime)
void	terminate()
protected void	unscheduleJob()

Methods inherited from class com.serotonin.mango.rt.event.detectors.PointEventDetectorRT

createEventContext, getEventDetectorKey, getEventType, getMessage, joinTermination, pointBackdated, pointChanged, pointInitialized, pointSet, pointTerminated, pointUpdated, raiseEvent, returnToNormal

Methods inherited from class com.serotonin.mango.rt.event.SimpleEventDetector

addListener, fireEventDetectorStateChanged, fireEventDetectorTerminated, hasListeners, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.serotonin.mango.rt.event.EventDetector

isEventActive

Field Detail

durationMS

private long durationMS

Internal configuration field. The millisecond version of the duration fields.

durationDescription

private com.serotonin.web.i18n.LocalizableMessage durationDescription

Internal configuration field. The human-readable description of the duration fields.

task

private com.serotonin.timer.TimerTask task

Internal configuration field. The unique name for this event producer to be used in the scheduler (if required).

Constructor Detail

TimeoutDetectorRT

public TimeoutDetectorRT()

Method Detail

initialize

public void initialize()

Specified by:

initialize in interface com.serotonin.util.ILifecycle

Overrides:

initialize in class PointEventDetectorRT

isJobScheduled

protected boolean isJobScheduled()

terminate

public void terminate()

Specified by:

terminate in interface com.serotonin.util.ILifecycle

Overrides:

terminate in class PointEventDetectorRT

getDurationDescription

protected com.serotonin.web.i18n.LocalizableMessage getDurationDescription()

getDurationMS

protected long getDurationMS()

scheduleJob

protected void scheduleJob(long timeout)

unscheduleJob

protected void unscheduleJob()

scheduleTimeout

public final void scheduleTimeout(long fireTime)

Specified by:

scheduleTimeout in interface TimeoutClient

scheduleTimeoutImpl

protected abstract void scheduleTimeoutImpl(long fireTime)

cancelTask

private void cancelTask()