com.serotonin.mango.rt.publish

Class PublisherRT<T extends PublishedPointVO>

java.lang.Object

com.serotonin.mango.rt.publish.PublisherRT<T>

All Implemented Interfaces:

TimeoutClient

Direct Known Subclasses:

HttpSenderRT, PachubeSenderRT, PersistentSenderRT

public abstract class PublisherRT<T extends PublishedPointVO>
extends java.lang.Object
implements TimeoutClient

Author:

Matthew Lohbihler

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Thread	jobThread
private java.lang.Object	persistentDataLock
static int	POINT_DISABLED_EVENT
private boolean	pointDisabledEventActive
private EventType	pointDisabledEventType
protected java.util.List<PublishedPointRT<T>>	pointRTs
protected PublishQueue<T>	queue
static int	QUEUE_SIZE_WARNING_EVENT
private EventType	queueSizeWarningEventType
private SendThread	sendThread
private com.serotonin.timer.TimerTask	snapshotTask
private PublisherVO<T>	vo

Constructor Summary

Constructors

Constructor and Description
PublisherRT(PublisherVO<T> vo)

Method Summary

Modifier and Type	Method and Description
private void	checkForDisabledPoints()
protected java.util.Map<java.lang.String,java.lang.Object>	createEventContext()
protected PublishQueue<T>	createPublishQueue(PublisherVO<T> vo)
(package private) void	deactivateQueueSizeWarningEvent()
(package private) void	fireQueueSizeWarningEvent()
int	getId()
java.lang.Object	getPersistentData(java.lang.String key) This method is usable by subclasses to retrieve serializable data stored using the setPersistentData method.
PublisherVO<T>	getVo()
abstract void	initialize()
protected void	initialize(SendThread sendThread)
void	joinTermination()
protected void	pointInitialized(PublishedPointRT<T> rt)
protected void	pointTerminated(PublishedPointRT<T> rt)
void	publish(T vo, java.util.List<PointValueTime> newValues)
(package private) void	publish(T vo, PointValueTime newValue)
void	scheduleTimeout(long fireTime)
void	setPersistentData(java.lang.String key, java.lang.Object persistentData) This method is usable by subclasses to store any type of serializable data.
void	terminate()

Methods inherited from class java.lang.Object

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

Field Detail

POINT_DISABLED_EVENT

public static final int POINT_DISABLED_EVENT

See Also:

Constant Field Values

QUEUE_SIZE_WARNING_EVENT

public static final int QUEUE_SIZE_WARNING_EVENT

See Also:

Constant Field Values

persistentDataLock

private final java.lang.Object persistentDataLock

pointDisabledEventType

private final EventType pointDisabledEventType

queueSizeWarningEventType

private final EventType queueSizeWarningEventType

vo

private final PublisherVO<T extends PublishedPointVO> vo

pointRTs

protected final java.util.List<PublishedPointRT<T extends PublishedPointVO>> pointRTs

queue

protected final PublishQueue<T extends PublishedPointVO> queue

pointDisabledEventActive

private boolean pointDisabledEventActive

jobThread

private volatile java.lang.Thread jobThread

sendThread

private SendThread sendThread

snapshotTask

private com.serotonin.timer.TimerTask snapshotTask

Constructor Detail

PublisherRT

public PublisherRT(PublisherVO<T> vo)

Method Detail

getId

public int getId()

createPublishQueue

protected PublishQueue<T> createPublishQueue(PublisherVO<T> vo)

getVo

public PublisherVO<T> getVo()

getPersistentData

public java.lang.Object getPersistentData(java.lang.String key)

This method is usable by subclasses to retrieve serializable data stored using the setPersistentData method.

setPersistentData

public void setPersistentData(java.lang.String key,
                              java.lang.Object persistentData)

This method is usable by subclasses to store any type of serializable data. This intention is to provide a mechanism for publisher RTs to be able to persist data between runs. Normally this method would at least be called in the terminate method, but may also be called regularly for failover purposes.

publish

void publish(T vo,
             PointValueTime newValue)

publish

public void publish(T vo,
                    java.util.List<PointValueTime> newValues)

pointInitialized

protected void pointInitialized(PublishedPointRT<T> rt)

pointTerminated

protected void pointTerminated(PublishedPointRT<T> rt)

checkForDisabledPoints

private void checkForDisabledPoints()

fireQueueSizeWarningEvent

void fireQueueSizeWarningEvent()

deactivateQueueSizeWarningEvent

void deactivateQueueSizeWarningEvent()

createEventContext

protected java.util.Map<java.lang.String,java.lang.Object> createEventContext()

initialize

public abstract void initialize()

initialize

protected void initialize(SendThread sendThread)

terminate

public void terminate()

joinTermination

public void joinTermination()

scheduleTimeout

public void scheduleTimeout(long fireTime)

Specified by:

scheduleTimeout in interface TimeoutClient