public class SecsEvent
extends java.util.EventObject
Modifier and Type | Field and Description |
---|---|
static int |
ALL_EVENTS
This is the minimum value for user defined or other events.
|
static int |
BLOCK_RECEIVE_ERROR
This event is posted when blocks cannot be received.
|
static int |
BLOCK_SEND_ERROR
This event is posted when blocks cannot be sent.
|
static int |
BLOCK_WARNING
This event is posted when blocks are received in the wrong order (SECSI only).
|
static int |
CANNOT_CHANGE_TO_SS
This event is posted whenever a request to convert a session to Single Session
but the session is already General Session.
|
static int |
CHANGING_TO_SS
This event is posted whenever an HSMS session/connection is converted to
Single Session.
|
static int |
CHECKSUM_ERROR
This event is posted when a message with a checksum error is received (SECSI only).
|
static int |
COMMUNICATION_STATE_COMMUNICATING
This event is posted when the state is changed to communicating.
|
static int |
COMMUNICATION_STATE_DISABLED
This event is posted when the state is changed to disabled.
|
static int |
COMMUNICATION_STATE_NON_COMMUNICATING
This event is posted when the state is changed to non-communicating.
|
static int |
CONNECTION_ACCEPTED
This event is posted when a connection is accepted in HSMS Passive Mode.
|
static int |
CONNECTION_CLOSING
This event is posted when a connection is closed.
|
static int |
CONNECTION_DROPPED
This event is posted when a connection is dropped.
|
static int |
CONTENTION
This event is posted whenever a SECSI contention situation occurs.
|
static int |
CONTROL_STATE_ATTEMPT_ONLINE
This event is posted when the state is changed into ATTEMPT_ONLINE
The source of this message is the OnlineHandler and the user object
is a string.
|
static int |
CONTROL_STATE_EQUIPMENT_OFFLINE
This event is posted when the state is changed into EQUIPMENT_OFFLINE
|
static int |
CONTROL_STATE_HOST_OFFLINE
This event is posted when the state is changed into HOST_OFFLINE
The source of this message is the OnlineHandler and the user object
is a string.
|
static int |
CONTROL_STATE_LOCAL_ONLINE
This event is posted when the state is changed into LOCAL_ONLINE
The source of this message is the OnlineHandler and the user object
is a string.
|
static int |
CONTROL_STATE_REMOTE_ONLINE
This event is posted when the state is changed into REMOTE_ONLINE
The source of this message is the OnlineHandler and the user object
is a string.
|
static java.lang.String |
cvsRev |
static int |
DEFAULTLEVEL |
static int |
DISABLED_MESSAGE_BLOCKED
This event is posted when the state is disabled and a message
that isn't allowed is attempted to be sent.
|
static int |
DUPLICATE_MESSAGE
This event is posted when a duplicate message is received.
|
static int |
ERROR
This event is posted when an error that is not otherwise described.
|
static int |
EVENT_UNKNOWN |
static int |
GS_CONNECTION_IN_SS_MODE
This event is posted when a General Session message is received in
Single Session Mode.
|
static int |
HSMS_ERROR_INVALID_PROTOCOL
This event is posted whenever an HSMS request with an unknown
ptype is received.
|
static int |
HSMS_GS_INFO_VALID_SELECT_REQUEST
This event is posted whenever valid HSMS select request is received.
|
static int |
HSMS_GS_INVALID_DESLECT_REQUEST
This event is posted whenever invalid HSMS deselect request is received.
|
static int |
HSMS_GS_INVALID_DESLECT_RESPONSE
This event is posted whenever invalid HSMS deselect response is received.
|
static int |
HSMS_GS_INVALID_REJECT_REQUEST
This event is posted whenever invalid HSMS reject request is received.
|
static int |
HSMS_GS_INVALID_SELECT_REQUEST
This event is posted whenever invalid HSMS select request is received.
|
static int |
HSMS_GS_INVALID_SELECT_RESPONSE
This event is posted whenever invalid HSMS select response is received.
|
static int |
HSMS_GS_INVALID_STYPE
This event is posted whenever an HSMS request with an unknown
stype is received.
|
static int |
HSMS_GS_LINK_TEST_REQUEST
This event is posted whenever valid HSMS linktest request is received.
|
static int |
HSMS_GS_LINK_TEST_RESPONSE
This event is posted whenever valid HSMS linktest response is received.
|
static int |
HSMS_GS_LINK_TEST_RESPONSE_TRANSACTION_NOT_OPEN
This event is posted whenever an HSMS linktest response is received and there
is no open transaction.
|
static int |
HSMS_GS_SELECT_TRANSACTION_NOT_OPEN
This event is posted whenever an HSMS select response is received and there
is no open transaction.
|
static int |
HSMS_GS_VALID_DESLECT_REQUEST
This event is posted whenever valid HSMS deselect request is received.
|
static int |
HSMS_GS_VALID_DESLECT_RESPONSE
This event is posted whenever valid HSMS deselect response is received.
|
static int |
HSMS_GS_VALID_REJECT_REQUEST
This event is posted whenever valid HSMS reject request is received.
|
static int |
HSMS_GS_VALID_SELECT_RESPONSE
This event is posted whenever valid HSMS select response is received.
|
static int |
HSMS_GS_VALID_SEPARATE_REQUEST
This event is posted whenever valid HSMS separate request is received.
|
static int |
HSMS_MSG_FORMAT_ERROR
This event is posted whenever an HSMS request is invalid.
|
static int |
HSMS_SESSION_NOT_SELECTED
This event is posted whenever an HSMS request on an unselected session.
|
static int |
HSMS_SS_DESLECT
This event is posted whenever invalid HSMS deselect response is received.
|
static int |
HSMS_SS_INFO_VALID_SELECT_REQUEST
This event is posted whenever valid HSMS select request is received.
|
static int |
HSMS_SS_INVALID_DESLECT_REQUEST
This event is posted whenever invalid HSMS deselect request is received.
|
static int |
HSMS_SS_INVALID_SELECT_REQUEST
This event is posted whenever invalid HSMS select request is received.
|
static int |
HSMS_SS_INVALID_SELECT_RESPONSE
This event is posted whenever invalid HSMS select response is received.
|
static int |
HSMS_SS_INVALID_STYPE
This event is posted whenever an HSMS request with an unknown
stype is received.
|
static int |
HSMS_SS_LINK_TEST_REQUEST
This event is posted whenever valid HSMS linktest request is received.
|
static int |
HSMS_SS_LINK_TEST_RESPONSE
This event is posted whenever valid HSMS linktest response is received.
|
static int |
HSMS_SS_LINK_TEST_RESPONSE_TRANSACTION_NOT_OPEN
This event is posted whenever an HSMS linktest response is received and there
is no open transaction.
|
static int |
HSMS_SS_REJECT_REQUEST
This event is posted whenever an HSMS reject request is received.
|
static int |
HSMS_SS_SELECT_TRANSACTION_NOT_OPEN
This event is posted whenever an HSMS select response is received and there
is no open transaction.
|
static int |
HSMS_SS_VALID_DESLECT_REQUEST
This event is posted whenever valid HSMS deselect request is received.
|
static int |
HSMS_SS_VALID_DESLECT_RESPONSE
This event is posted whenever valid HSMS deselect response is received.
|
static int |
HSMS_SS_VALID_SELECT_RESPONSE
This event is posted whenever valid HSMS select response is received.
|
static int |
HSMS_SS_VALID_SEPARATE_REQUEST
This event is posted whenever valid HSMS separate request is received.
|
static int |
INFORMATION
This event is posted when some indication of something interesting.
|
static int |
INVALID_DEVICE_ID_WARNING
This event is posted when a message with an invalid Device ID is received.
|
static int |
MAX_ERROR_EVENT
This is the maximum value for error events.
|
static int |
MAX_INFORMATION_EVENT
This is the maximum value for information events.
|
static int |
MAX_WARNING_EVENT
This is the maximum value for warning events.
|
static int |
MESSAGE_SEND_ERROR
This event is posted when a message cannot be sent.
|
static int |
MESSAGE_TIMEOUT_WARNING
This event is posted when a message fails, but the system will
automatically retry the message.
|
static int |
MIN_ERROR_EVENT
This is the minimum value for error events.
|
static int |
MIN_GEM_EVENT
This is the lowest GEM event.
|
static int |
MIN_INFORMATION_EVENT
This is the minimum value for information events.
|
static int |
MIN_OTHER_EVENT
This is the minimum value for user defined or other events.
|
static int |
MIN_WARNING_EVENT
This is the minimum value for warning events.
|
static int |
MULTI_BLOCK_REJECT
This event is posted when a multi-block request is rejected.
|
static int |
NAK_ERROR
This event is posted when a NAK is received (SECSI only).
|
static int |
NAK_WARNING
This event is posted when a NAK is received (SECSI only).
|
static int |
NOT_COMMUNICATION_MESSAGE_BLOCKED
This event is posted when the state is non-communicating and a message
that isn't allowed is attempted to be sent.
|
static int |
OPEN_PORT_ERROR
This event is posted whenever a error occurs opening a port that cannot be
described more precisely.
|
static int |
PORT_ERROR
This event is posted when there is a critical error with the port.
|
static int |
PORT_IN_USE_ERROR
This event is posted when an attempt is made to open a port that is already in use.
|
static int |
PORT_INFO
This event provides some information about changing port status.
|
static int |
PORT_WARNING
This event is posted when a non-critical error occurs on a port.
|
static int |
SESSION_CREATED
This event is posted when a session is created.
|
static int |
SS_CONNECTION_IN_GS_MODE
This event is posted when a Single Session message is received in
General Session Mode.
|
static int |
STREAM_ERROR
This event is posted when the system cannot attach input or output streams to the port.
|
static int |
T1_TIMEOUT_ERROR
This event is posted when a T1 Timeout Occurs.
|
static int |
T2_TIMEOUT_ERROR
This event is posted when a T2 Timeout Occurs.
|
static int |
T3_TIMEOUT_ERROR
This event is posted when a T3 Timeout Occurs.
|
static int |
T4_TIMEOUT_ERROR
This event is posted when a T4 Timeout Occurs.
|
static int |
T5_TIMEOUT_ERROR
This event is posted when a T5 Timeout Occurs.
|
static int |
T6_TIMEOUT_ERROR
This event is posted when a T6 Timeout Occurs.
|
static int |
T7_TIMEOUT_ERROR
This event is posted when a T7 Timeout Occurs.
|
static int |
T8_TIMEOUT_ERROR
This event is posted when a T8 Timeout Occurs.
|
static int |
TOO_MANY_CONNECTIONS
This event is posted when an HSMS connection request is made but the connection count
has been exceeded.
|
static int |
WARNING
This event is posted when a warning is received that is not specified elsewhere.
|
Constructor and Description |
---|
SecsEvent(java.lang.Object source)
This is the generic constructor.
|
SecsEvent(java.lang.Object source,
int id)
This constructor is here if you want to post an event with only the event number.
|
SecsEvent(java.lang.Object source,
int id,
int subId)
This constructor is here if you want to post an event with only the event number.
|
SecsEvent(java.lang.Object source,
int id,
int subId,
java.lang.String name)
This constructor if you only want to post the id and the name of the event.
|
SecsEvent(java.lang.Object source,
int id,
int subId,
java.lang.String name,
int lvl,
java.lang.Object userObject)
This is the most common constructor for SecsEvents that are created from a server.
|
SecsEvent(java.lang.Object source,
int id,
int subId,
java.lang.String name,
java.lang.Object userObject)
This constructor is used when you have all the information for a normal event (normal lvl).
|
SecsEvent(java.lang.Object source,
int id,
java.lang.String name)
This constructor is here if you want to post an event with only the event number.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDescription()
This will return the description of the SecsEvent.
|
int |
getId()
This will return the id of the events source.
|
int |
getlevel() |
java.lang.String |
getName()
This will return the name of the SecsEvent.
|
java.lang.Object |
getSource()
This will return the TagAgent of the events source.
|
int |
getSubId()
This is the subId.
|
java.lang.Object |
getUserObject()
This is a object passed in by the creator of the event.
|
void |
post()
This will post this event to the default event handler.
|
static void |
post(java.lang.Object source,
int id,
int subId,
java.lang.String name,
int lvl)
This will create a new SecsEvent and post it.
|
static void |
post(java.lang.Object source,
int id,
int subId,
java.lang.String name,
java.lang.Object userObject,
int lvl)
This will create a new SecsEvent and post it.
|
static void |
post(java.lang.Object source,
int id,
java.lang.String name,
int lvl)
This will create a new SecsEvent and post it.
|
static void |
post(java.lang.Object source,
int id,
java.lang.String name,
java.lang.Object userObject,
int lvl)
This will create a new SecsEvent and post it.
|
void |
post(SecsEventHandler theHandler)
This will post this event to the default event handler.
|
void |
setDescription(java.lang.String newValue)
This will set the description of the event.
|
void |
setId(int newValue)
This will set the id of the events source.
|
void |
setLevel(int newValue) |
void |
setName(java.lang.String newValue)
This will set the name of the event.
|
void |
setSource(java.lang.Object newValue)
This will set the TagAgent of the events source.
|
void |
setSubId(int newValue)
This is the subId.
|
void |
setUserObject(java.lang.Object newValue)
This is a object passed in by the creator of the event.
|
java.lang.String |
toString()
This will make a human readable string describing the Event
|
public static final int ALL_EVENTS
public static final int BLOCK_RECEIVE_ERROR
public static final int BLOCK_SEND_ERROR
public static final int BLOCK_WARNING
public static final int CANNOT_CHANGE_TO_SS
public static final int CHANGING_TO_SS
public static final int CHECKSUM_ERROR
public static final int COMMUNICATION_STATE_COMMUNICATING
public static final int COMMUNICATION_STATE_DISABLED
public static final int COMMUNICATION_STATE_NON_COMMUNICATING
public static final int CONNECTION_ACCEPTED
public static final int CONNECTION_CLOSING
The user object is null.
,
Constant Field Valuespublic static final int CONNECTION_DROPPED
The user object is null.
,
Constant Field Valuespublic static final int CONTENTION
public static final int CONTROL_STATE_ATTEMPT_ONLINE
public static final int CONTROL_STATE_EQUIPMENT_OFFLINE
public static final int CONTROL_STATE_HOST_OFFLINE
public static final int CONTROL_STATE_LOCAL_ONLINE
public static final int CONTROL_STATE_REMOTE_ONLINE
public static final java.lang.String cvsRev
public static int DEFAULTLEVEL
public static final int DISABLED_MESSAGE_BLOCKED
public static final int DUPLICATE_MESSAGE
public static final int ERROR
public static final int EVENT_UNKNOWN
public static final int GS_CONNECTION_IN_SS_MODE
public static final int HSMS_ERROR_INVALID_PROTOCOL
public static final int HSMS_GS_INFO_VALID_SELECT_REQUEST
public static final int HSMS_GS_INVALID_DESLECT_REQUEST
public static final int HSMS_GS_INVALID_DESLECT_RESPONSE
public static final int HSMS_GS_INVALID_REJECT_REQUEST
public static final int HSMS_GS_INVALID_SELECT_REQUEST
public static final int HSMS_GS_INVALID_SELECT_RESPONSE
public static final int HSMS_GS_INVALID_STYPE
public static final int HSMS_GS_LINK_TEST_REQUEST
public static final int HSMS_GS_LINK_TEST_RESPONSE
public static final int HSMS_GS_LINK_TEST_RESPONSE_TRANSACTION_NOT_OPEN
public static final int HSMS_GS_SELECT_TRANSACTION_NOT_OPEN
public static final int HSMS_GS_VALID_DESLECT_REQUEST
public static final int HSMS_GS_VALID_DESLECT_RESPONSE
public static final int HSMS_GS_VALID_REJECT_REQUEST
public static final int HSMS_GS_VALID_SELECT_RESPONSE
public static final int HSMS_GS_VALID_SEPARATE_REQUEST
public static final int HSMS_MSG_FORMAT_ERROR
public static final int HSMS_SESSION_NOT_SELECTED
public static final int HSMS_SS_DESLECT
public static final int HSMS_SS_INFO_VALID_SELECT_REQUEST
public static final int HSMS_SS_INVALID_DESLECT_REQUEST
public static final int HSMS_SS_INVALID_SELECT_REQUEST
public static final int HSMS_SS_INVALID_SELECT_RESPONSE
public static final int HSMS_SS_INVALID_STYPE
public static final int HSMS_SS_LINK_TEST_REQUEST
public static final int HSMS_SS_LINK_TEST_RESPONSE
public static final int HSMS_SS_LINK_TEST_RESPONSE_TRANSACTION_NOT_OPEN
public static final int HSMS_SS_REJECT_REQUEST
public static final int HSMS_SS_SELECT_TRANSACTION_NOT_OPEN
public static final int HSMS_SS_VALID_DESLECT_REQUEST
public static final int HSMS_SS_VALID_DESLECT_RESPONSE
public static final int HSMS_SS_VALID_SELECT_RESPONSE
public static final int HSMS_SS_VALID_SEPARATE_REQUEST
public static final int INFORMATION
public static final int INVALID_DEVICE_ID_WARNING
public static final int MAX_ERROR_EVENT
public static final int MAX_INFORMATION_EVENT
public static final int MAX_WARNING_EVENT
public static final int MESSAGE_SEND_ERROR
public static final int MESSAGE_TIMEOUT_WARNING
public static final int MIN_ERROR_EVENT
public static final int MIN_GEM_EVENT
public static final int MIN_INFORMATION_EVENT
public static final int MIN_OTHER_EVENT
public static final int MIN_WARNING_EVENT
public static final int MULTI_BLOCK_REJECT
public static final int NAK_ERROR
public static final int NAK_WARNING
public static final int NOT_COMMUNICATION_MESSAGE_BLOCKED
public static final int OPEN_PORT_ERROR
public static final int PORT_ERROR
public static final int PORT_IN_USE_ERROR
public static final int PORT_INFO
public static final int PORT_WARNING
public static final int SESSION_CREATED
public static final int SS_CONNECTION_IN_GS_MODE
public static final int STREAM_ERROR
public static final int T1_TIMEOUT_ERROR
public static final int T2_TIMEOUT_ERROR
public static final int T3_TIMEOUT_ERROR
public static final int T4_TIMEOUT_ERROR
public static final int T5_TIMEOUT_ERROR
public static final int T6_TIMEOUT_ERROR
public static final int T7_TIMEOUT_ERROR
public static final int T8_TIMEOUT_ERROR
public static final int TOO_MANY_CONNECTIONS
public static final int WARNING
public SecsEvent(java.lang.Object source)
source
- This is the source of the event.public SecsEvent(java.lang.Object source, int id)
source
- This is the source of the event.id
- This is an optional id that can be accessed later.public SecsEvent(java.lang.Object source, int id, int subId)
source
- This is the source of the event.id
- This is an optional id that can be accessed later.public SecsEvent(java.lang.Object source, int id, int subId, java.lang.String name)
source
- This is the source of the event.id
- This is id that can be accessed later.name
- This is string representing the name of the eventpublic SecsEvent(java.lang.Object source, int id, int subId, java.lang.String name, int lvl, java.lang.Object userObject)
source
- This is the source of the event.id
- This is id that can be accessed later.name
- This is string representing the name of the eventdescription
- This is a full description of the event.lvl
- This is the level of severity for the event.public SecsEvent(java.lang.Object source, int id, int subId, java.lang.String name, java.lang.Object userObject)
public SecsEvent(java.lang.Object source, int id, java.lang.String name)
source
- This is the source of the event.id
- This is an optional id that can be accessed later.public java.lang.String getDescription()
setDescription(java.lang.String)
public int getId()
setId(int)
public int getlevel()
public java.lang.String getName()
setName(java.lang.String)
public java.lang.Object getSource()
getSource
in class java.util.EventObject
setSource(java.lang.Object)
,
#getTagAgent
public int getSubId()
public java.lang.Object getUserObject()
public void post()
public static void post(java.lang.Object source, int id, int subId, java.lang.String name, int lvl)
public static void post(java.lang.Object source, int id, int subId, java.lang.String name, java.lang.Object userObject, int lvl)
public static void post(java.lang.Object source, int id, java.lang.String name, int lvl)
public static void post(java.lang.Object source, int id, java.lang.String name, java.lang.Object userObject, int lvl)
public void post(SecsEventHandler theHandler)
public void setDescription(java.lang.String newValue)
newValue
- This is the new description.getDescription()
public void setId(int newValue)
newValue
- This is the new ID.getId()
public void setLevel(int newValue)
public void setName(java.lang.String newValue)
newValue
- This is the new name.getName()
public void setSource(java.lang.Object newValue)
newValue
- This is the new source in the form of a TagAgent.getSource()
,
#getTagAgent
public void setSubId(int newValue)
public void setUserObject(java.lang.Object newValue)
public java.lang.String toString()
toString
in class java.util.EventObject
Copyright © 1999-2025 ErgoTech Systems, Inc. All Rights Reserved.