com.ergotech.secs

Class TransactionManager

java.lang.Object

com.ergotech.secs.TransactionManager

All Implemented Interfaces:

MessageResponseInterface, SecsEventListener, SystemHandlerInterface, java.lang.Runnable, java.util.EventListener

public class TransactionManager
extends java.lang.Object
implements SystemHandlerInterface, MessageResponseInterface, java.lang.Runnable, SecsEventListener

This will spool all outgoing messages from the time a primary is sent until the response is received. After the response is received it will de-spool all the saved messages, one at a time, waiting for the response or T3 on each before sending the next. This also implies that only a single transaction is open at any given time.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev
static int	debugLevel Our debug level.
static int	queueTimeout The amount of time (in seconds) the messages can sit in the queue before being timed-out.

Constructor Summary

Constructors

Constructor and Description
TransactionManager(java.lang.String equipmentName)

Method Summary

Modifier and Type	Method and Description
void	deSpool() Despool the event messages one at a time.
java.lang.String	getEquipmentName()
boolean	processMessage(SecsTrigger imsg) Check all incoming messages for primaries that require a response.
boolean	responseReceived(int status, SecsMsg primary, SecsMsg response) The MsgResponseInterface.
void	run() The watchdog code.
void	secsEvent(SecsEvent theEvent) Catch the secs events.
boolean	verifyMessage(SecsMsg msg) This method checks to see if the outgoing message is a primary.

Methods inherited from class java.lang.Object

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

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

debugLevel

public static int debugLevel

Our debug level.

queueTimeout

public static int queueTimeout

The amount of time (in seconds) the messages can sit in the queue before being timed-out. Default is 180 seconds or three minutes.

Constructor Detail

TransactionManager

public TransactionManager(java.lang.String equipmentName)

Method Detail

deSpool

public void deSpool()

Despool the event messages one at a time.

getEquipmentName

public java.lang.String getEquipmentName()

Returns:

Returns the equipmentName.

processMessage

public boolean processMessage(SecsTrigger imsg)

Check all incoming messages for primaries that require a response.

responseReceived

public boolean responseReceived(int status,
                                SecsMsg primary,
                                SecsMsg response)

The MsgResponseInterface. This will continue to despool messages.

Specified by:

responseReceived in interface MessageResponseInterface

run

public void run()

The watchdog code.

Specified by:

run in interface java.lang.Runnable

secsEvent

public void secsEvent(SecsEvent theEvent)

Catch the secs events. This will catch port errors, T3 the entire contents of the spooler and clear the spool.

Specified by:

secsEvent in interface SecsEventListener

Parameters:

theEvent - the event

verifyMessage

public boolean verifyMessage(SecsMsg msg)
                      throws SecsException

This method checks to see if the outgoing message is a primary. If so, it will save the message and start spooling all other outgoing messages. Outgoing messages are spooled as long as the spool is not empty. It will also check if the outgoing message is a response to the incoming primary that we are holding. In this case it will indicate that one transaction has closed.

Specified by:

verifyMessage in interface SystemHandlerInterface

Throws:

SecsException