com.ergotech.secs.gem

Class EventSpooler

java.lang.Object

com.ergotech.secs.gem.EventSpooler

All Implemented Interfaces:

MessageResponseInterface, SystemHandlerInterface

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

This will spool all outgoing messages from the time a primary is received until the response is sent. After the response is sent 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 host sends a primary until after the reponse is sent by the tool. and will then send all the messages it has spooled.

Field Summary

Fields

Modifier and Type	Field and Description
static double	timeout This defines how long we will wait for the primary to be processed and a response returned.

Fields inherited from interface com.ergotech.secs.SystemHandlerInterface

cvsRev

Fields inherited from interface com.ergotech.secs.MessageResponseInterface

cvsRev

Method Summary

Modifier and Type	Method and Description
void	deSpool() Despool the event messages one at a time and reset the primary message.
void	destroy() Destroy the despooler.
static EventSpooler	existingEventSpooler(java.lang.String toolName) Return an existing event despooler or null if none exists
static EventSpooler	getEventSpooler(java.lang.String toolName) Return an existing or new event spooler for the given equipment name.
boolean	processMessage(SecsTrigger imsg) Check all incoming messages for primaries that require a response.
boolean	responseReceived(int status, SecsMsg primary, SecsMsg response) The MsgResponseInterface.
boolean	verifyMessage(SecsMsg msg) This method will be called on ALL outgoing messages (for each system message handler).

Methods inherited from class java.lang.Object

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

Field Detail

timeout

public static double timeout

This defines how long we will wait for the primary to be processed and a response returned. This is somewhat like a T3, but since this is all local, no network hops or similar it should not take too long. The default is 5 seconds.

Method Detail

deSpool

public void deSpool()

Despool the event messages one at a time and reset the primary message.

destroy

public void destroy()

Destroy the despooler.

existingEventSpooler

public static EventSpooler existingEventSpooler(java.lang.String toolName)

Return an existing event despooler or null if none exists

Parameters:

toolName - the name of the tool associated with this despooler

Returns:

the despooler or null if none exists.

getEventSpooler

public static EventSpooler getEventSpooler(java.lang.String toolName)

Return an existing or new event spooler for the given equipment name.

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

verifyMessage

public boolean verifyMessage(SecsMsg msg)
                      throws SecsException

Description copied from interface: SystemHandlerInterface

This method will be called on ALL outgoing messages (for each system message handler). If the message is allowed to be sent, then this will return normally. If it can't be sent, then it will either throw or return false. If the handler returns false the message will be silently ignored, unless one of the other handlers throws.

Specified by:

verifyMessage in interface SystemHandlerInterface

Throws:

SecsException