com.ergotech.secs.gem

Class EventOutSpooler

java.lang.Object

com.ergotech.secs.gem.EventOutSpooler

All Implemented Interfaces:

MessageResponseInterface, SystemHandlerInterface

public class EventOutSpooler
extends java.lang.Object
implements SystemHandlerInterface, MessageResponseInterface

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. To clarify, this spooler will prevent eg events being sent from the time the tool sends a primary to the host until after the reponse is received from the host. That is, each transaction to the host will be unique and complete before another transaction to the host is started. As soon as the response from the host is received it will then send all the messages it has spooled one at a time..

Field Summary

Fields

Modifier and Type	Field and Description
static int	debugLevel Our debug level.

Fields inherited from interface com.ergotech.secs.SystemHandlerInterface

cvsRev

Fields inherited from interface com.ergotech.secs.MessageResponseInterface

cvsRev

Constructor Summary

Constructors

Constructor and Description
EventOutSpooler()

Method Summary

Modifier and Type	Method and Description
void	deSpool() Despool the event messages one at a time.
boolean	processMessage(SecsTrigger imsg) This method will find the response message and halt it's processing.
boolean	responseReceived(int status, SecsMsg primary, SecsMsg response) The MsgResponseInterface.
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

debugLevel

public static int debugLevel

Our debug level.

Constructor Detail

EventOutSpooler

public EventOutSpooler()

Method Detail

deSpool

public void deSpool()

Despool the event messages one at a time.

processMessage

public boolean processMessage(SecsTrigger imsg)

This method will find the response message and halt it's processing. It will reprocess it at a later date. There are some potential pitfalls here, but none should occur in practice. We are the last of the SystemMessageHandlers, and so will be processed after the Comm and Control states. So by the time the message gets here it has successfully negotiated these. However, when we reprocess one of these may fail. This will occur only in unusual cases, like the connection closing, and the error is relatively minor.

responseReceived

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

The MsgResponseInterface. This will continue to despool messages.

Specified by:

responseReceived in interface MessageResponseInterface

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.

Specified by:

verifyMessage in interface SystemHandlerInterface

Throws:

SecsException