com.ergotech.secs.gem

Class CommunicationsHandler

java.lang.Object

com.ergotech.secs.gem.SendEvent

com.ergotech.secs.gem.CommunicationsHandler

All Implemented Interfaces:

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

public class CommunicationsHandler
extends SendEvent
implements SystemHandlerInterface, SecsEventListener, MessageResponseInterface, java.lang.Runnable, java.io.Serializable

This System Handler will maintain the current state of the equipment (Communicating, Not-Communicating, Disabled) This will also stop the flow of messages in both directions when the state is not communicating.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMUNICATING Constant COMMUNICATING.
static int	DISABLED Constant DISABLED.
static int	EQUIPMENT_INITIATED_CONNECT Constant EQUIPMENT_INITIATED_CONNECT.
static int	EQUIPMENT_INITIATED_CONNECT_WAIT_CRA Constant EQUIPMENT_INITIATED_CONNECT_WAIT_CRA.
static int	EQUIPMENT_INITIATED_CONNECT_WAIT_DELAY Constant EQUIPMENT_INITIATED_CONNECT_WAIT_DELAY.
static int	HOST_INITIATED_CONNECT Constant HOST_INITIATED_CONNECT.
static int	initialState The initial state NOT_COMMUNICATING.
static int	MAX_STATE Constant MAX_STATE (COMMUNICATING).
static int	NOT_COMMUNICATING Constant NOT_COMMUNICATING.
static int	WAIT_CR_FROM_HOST Constant WAIT_CR_FROM_HOST.

Fields inherited from class com.ergotech.secs.gem.SendEvent

equipmentName

Fields inherited from interface com.ergotech.secs.SystemHandlerInterface

cvsRev

Fields inherited from interface com.ergotech.secs.SecsEventListener

cvsRev

Fields inherited from interface com.ergotech.secs.MessageResponseInterface

cvsRev

Constructor Summary

Constructors

Constructor and Description
CommunicationsHandler() General Constructor.
CommunicationsHandler(java.lang.String equipmentName) General Constructor.

Method Summary

Modifier and Type	Method and Description
void	addStateChangeNotifier(StateChangeNotification notifier) Object added will recieve notification of state changes.
void	changeState(int state) Changes the state to the specified state.
void	commDelayTracker(int commDelayVal) This method tracks changes to "EstablishCommunicationsTimeout" and will start the thread if the delay is non-zero and the thread is not already running.
void	commDelayTracker(ValueChangedEvent e) This method tracks changes to "EstablishCommunicationsTimeout" and will start the thread if the delay is non-zero and the thread is not already running.
void	destroy() Remove all listeners and clean up the connection manager.
int	getCurrentState() This will return the current state of the machine.
java.lang.String	getEquipmentName()
boolean	isEnabled() This will return true if we are enabled.
boolean	processMessage(SecsTrigger msg) this method will make sure that we will not forward any messages if we are DISABLEDS or NOT_COMMUNICATING.
void	removeStateChangeNotifier(StateChangeNotification notifier) Removes an object that was recieving notification of state changes.
boolean	responseReceived(int status, SecsMsg primary, SecsMsg response) This method receives the response to the S1F13 sent out in "Not Communicating" and will change the state to "Wait Delay" if appropriate.
void	run() Send S1F13 until we are no long in "ATTEMPT_ONLINE" state.
void	secsEvent(SecsEvent e) This will receive a PORT_ERROR.
void	setEnabled(boolean newValue) This will set our state to enabled or disabled (based on newValue).
void	setEquipmentName(java.lang.String equipmentName)
boolean	verifyMessage(SecsMsg msg) This checks outgoing messages to make sure that we allow them to go out.

Methods inherited from class com.ergotech.secs.gem.SendEvent

addClockAsDVVAL, equals, getAllExtendedAttributes, getExtendedAttribute, hashCode, sendEvent, setAlarm, setExtendedAttribute

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMMUNICATING

public static final int COMMUNICATING

Constant COMMUNICATING.

See Also:

Constant Field Values

DISABLED

public static final int DISABLED

Constant DISABLED.

See Also:

Constant Field Values

EQUIPMENT_INITIATED_CONNECT

public static final int EQUIPMENT_INITIATED_CONNECT

Constant EQUIPMENT_INITIATED_CONNECT.

See Also:

Constant Field Values

EQUIPMENT_INITIATED_CONNECT_WAIT_CRA

public static final int EQUIPMENT_INITIATED_CONNECT_WAIT_CRA

Constant EQUIPMENT_INITIATED_CONNECT_WAIT_CRA.

See Also:

Constant Field Values

EQUIPMENT_INITIATED_CONNECT_WAIT_DELAY

public static final int EQUIPMENT_INITIATED_CONNECT_WAIT_DELAY

Constant EQUIPMENT_INITIATED_CONNECT_WAIT_DELAY.

See Also:

Constant Field Values

HOST_INITIATED_CONNECT

public static final int HOST_INITIATED_CONNECT

Constant HOST_INITIATED_CONNECT.

See Also:

Constant Field Values

initialState

public static int initialState

The initial state NOT_COMMUNICATING.

MAX_STATE

public static final int MAX_STATE

Constant MAX_STATE (COMMUNICATING).

See Also:

Constant Field Values

NOT_COMMUNICATING

public static final int NOT_COMMUNICATING

Constant NOT_COMMUNICATING.

See Also:

Constant Field Values

WAIT_CR_FROM_HOST

public static final int WAIT_CR_FROM_HOST

Constant WAIT_CR_FROM_HOST.

See Also:

Constant Field Values

Constructor Detail

CommunicationsHandler

public CommunicationsHandler()

General Constructor.

CommunicationsHandler

public CommunicationsHandler(java.lang.String equipmentName)

General Constructor.

Method Detail

addStateChangeNotifier

public void addStateChangeNotifier(StateChangeNotification notifier)

Object added will recieve notification of state changes.

changeState

public void changeState(int state)
                 throws DeclinedStateChangeException

Changes the state to the specified state. This will also send all required notifications.

Throws:

DeclinedStateChangeException - thrown if the state change is rejected

commDelayTracker

public void commDelayTracker(int commDelayVal)

This method tracks changes to "EstablishCommunicationsTimeout" and will start the thread if the delay is non-zero and the thread is not already running. It will stop the thread if the value transitions to zero.

commDelayTracker

public void commDelayTracker(ValueChangedEvent e)

This method tracks changes to "EstablishCommunicationsTimeout" and will start the thread if the delay is non-zero and the thread is not already running. It will stop the thread if the value transitions to zero.

destroy

public void destroy()

Remove all listeners and clean up the connection manager.

getCurrentState

public int getCurrentState()

This will return the current state of the machine.

getEquipmentName

public java.lang.String getEquipmentName()

Returns:

Returns the equipmentName.

isEnabled

public boolean isEnabled()

This will return true if we are enabled. False if we are disabled.

processMessage

public boolean processMessage(SecsTrigger msg)

this method will make sure that we will not forward any messages if we are DISABLEDS or NOT_COMMUNICATING. if we are NOT_COMMUNICATING and we receive a S1F13, we will change state to COMMUNICATING and then send the reply.

removeStateChangeNotifier

public void removeStateChangeNotifier(StateChangeNotification notifier)

Removes an object that was recieving notification of state changes.

responseReceived

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

This method receives the response to the S1F13 sent out in "Not Communicating" and will change the state to "Wait Delay" if appropriate.

Specified by:

responseReceived in interface MessageResponseInterface

run

public void run()

Send S1F13 until we are no long in "ATTEMPT_ONLINE" state.

Specified by:

run in interface java.lang.Runnable

secsEvent

public void secsEvent(SecsEvent e)

This will receive a PORT_ERROR. If we receive it, and we are in communicating then we will change to not_communicating state.

Specified by:

secsEvent in interface SecsEventListener

setEnabled

public void setEnabled(boolean newValue)

This will set our state to enabled or disabled (based on newValue). This will NOT change state if we are already communicating, and get a setEnabled.

setEquipmentName

public void setEquipmentName(java.lang.String equipmentName)

Parameters:

equipmentName - The equipmentName to set.

verifyMessage

public boolean verifyMessage(SecsMsg msg)
                      throws SecsException

This checks outgoing messages to make sure that we allow them to go out.

Specified by:

verifyMessage in interface SystemHandlerInterface

Throws:

SecsException