com.ergotech.secs

Interface UnrecoverableErrorInterface

public interface UnrecoverableErrorInterface

An object of this type can be registered with SecsMsg to control the behavior of errors that would normally result in the sending of a stream 9 message. The system will normally automatically send S9F1, S9F3 or S9F5, and S9F9 messages at the appropriate times. If an object of this type has been registered it will be called before sending any of these messages. Each of the methods has the option to handle the error, and the returning true, or not hanlding the error and returning false. If the method returns false, the system will continue with the default behavior. If the method returns true, the system will ingore its normal error processing routines.

There is no possibility to recover from these errors at this level. The interface simply provides a way to determine what response to the errors will be provided.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	cvsRev

Method Summary

Modifier and Type	Method and Description
default boolean	invalidDataFormat(java.lang.Object source, SecsMsg msg) This method is called if the system detects an invalid data format.
default boolean	invalidDeviceId(ConnectionManager source, byte[] msg) This method is called when a message is received on an invalid device ID.
default boolean	invalidStreamOrFunction(java.lang.Object source, SecsMsg msg) This method is called when a message is not understood.
default boolean	messageTimeout(SecsMsg msg) This method is called on a T3 timeout.

Field Detail

cvsRev

static final java.lang.String cvsRev

See Also:

Constant Field Values

Method Detail

invalidDataFormat

default boolean invalidDataFormat(java.lang.Object source,
                                  SecsMsg msg)

This method is called if the system detects an invalid data format. The system throws and exception and does not send an S9F7. Since the system does not send any messages at this point, the return for true and false as the same. The source of the error is either the message or the GEM handler. The may be incompletely initialized since the data was not understood, but the stream and function will be valid, assuming at least this much information could be gathered from the incoming byte stream.

Parameters:

source - the message - this will be incompletely initialized

msg - the message - this will be incompletely initialized

Returns:

true if the error has been handled, otherwise false

invalidDeviceId

default boolean invalidDeviceId(ConnectionManager source,
                                byte[] msg)

This method is called when a message is received on an invalid device ID. The normal response to this is to send an S9F1 message. The source of this message is a connection manager. The exact type depends on the communications protocol.

Parameters:

source - the connection manager that detected this error

msg - the incoming message that has the invalid id

Returns:

true if the error has been handled, otherwise false

See Also:

HSMSConnectionManager, SecsIConnectionManager

invalidStreamOrFunction

default boolean invalidStreamOrFunction(java.lang.Object source,
                                        SecsMsg msg)

This method is called when a message is not understood. The normal response to this is to send an S9F5 message if the SxF0 class exists and to send and S9F3 message if it does not. The source of this message is variable depending on how the determination of the error was made. If the message is unknown to the system and the SecsMsg flag "allowGenericSecsMessage" is false the source of the message and the message will be an identical S0F0 object. If the message is accepted, but no message handler handles the message, the is no handler returns "true" when asked to process the message, then the source of the message will be a SessionManager. If GEM is enabled and the system is in LOCAL_ONLINE or REMOTE_ONLINE and the message is not accepted, then the source of this error will be the GEM OnlineHandler.

Parameters:

source - the object that detected the problem

msg - the unhandlable error

Returns:

true if the error has been handled, otherwise false

messageTimeout

default boolean messageTimeout(SecsMsg msg)

This method is called on a T3 timeout. The default behavior is to send and S9F9 message. There is no source to this message, that is, the source of the error is the message itself. This only controls the sending of the S9F9 message. In particular, other notifications of the error, including the SecsEvent "T3_TIMEOUT_ERROR" will still be posted.

Parameters:

msg - the message that has timed out

Returns:

true if the error has been handled, otherwise false