com.ergotech.secs

Interface MessageResponseInterface

All Known Implementing Classes:

Alarm, AlarmAck, AlarmEnableAck, ALIDListRequest, ALIDListResponse, AllALIDListResponse, AreYouThereFromHost, AreYouThereFromTool, AreYouThereResponseFromHost, AreYouThereResponseFromTool, CEIDListRequest, CEIDListResponse, CEIDReportsRequest, CEIDReportsResponse, CommunicationsHandler, CreateReports, CreateReportsResponse, DeleteReport, DeleteReports, DisableEvents, DisableSpooling, DVIDListRequest, DVIDListResponse, ECIDListRequest, ECIDListResponse, ECIDValueRequest, ECIDValueResponse, EnableAlarm, EnableAllAlarms, EnableAllEvents, EnabledAlarmsListRequest, EnabledAlarmsListResponse, EnableDisableEvents, EnableEvents, EnableEventsResponse, EnableEventsResponse, EquipmentConstantData, EstablishCommunications, EstablishCommunicationsFromTool, EstablishCommunicationsResponse, EstablishCommunicationsResponseToTool, EventMessage, EventMessageACK, EventMessageDecoder, EventMinimumMessage, EventOutSpooler, EventReportData, EventReportRequest, EventSpooler, GemSpoolHandler, IndividualReportData, InvalidDeviceId, LinkReports, LinkReportsResponse, MultiblockGrant, MultiblockRequest, MultiBlockRequest, OnlineAck, RequestOnline, S15F1, S2F1, S2F39, S6F5, S7F1, SelectedEquipmentStatusData, SendS1F3Poll, SpoolDataRequest, Stream9, SVIDListRequest, SVIDListResponse, SVIDValueRequest, SVIDValueResponse, TraceData, TraceDataACK, TraceInitializationSend, TransactionManager, UnlinkReports, VIBInMessageBean, VIBInOutMessageBean, VIBMessageBean, VIBOutMessageBean

public interface MessageResponseInterface

This interface allows for the registration of an object to receive the response to a primary message.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
boolean	responseReceived(int status, SecsMsg primary, SecsMsg response) This method will be called when a response to the message is received.

Field Detail

cvsRev

static final java.lang.String cvsRev

See Also:

Constant Field Values

Method Detail

responseReceived

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

This method will be called when a response to the message is received. The status is one of the static finals listed in SecsMsg. The primary message will be valid and will simply be the message that was sent, the response message may be null and may not be the expected response. It will be null for a T3 and will be an S9 or an F0 message if the status is S9_ERROR or F0_ERROR respectively. It is guaranteed that the responseReceived will be called EXACTLY once (no more and no less) for each message that is sent that expects a reply.