Package jmri.jmrix.lenz
Class XNetHeartBeat
- java.lang.Object
-
- jmri.jmrix.lenz.XNetHeartBeat
-
- All Implemented Interfaces:
java.util.EventListener
,AbstractMRListener
,XNetListener
public class XNetHeartBeat extends java.lang.Object implements XNetListener
XNet specific class to send heartbeat messages to the XNet. Heartbeat messages are only required if no other messages are sent for a specific period of time, so any outgoing message should restart the timer.
-
-
Constructor Summary
Constructors Constructor Description XNetHeartBeat(XNetSystemConnectionMemo memo)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
dispose()
void
message(XNetMessage msg)
Member function that will be invoked by an XNetInterface implementation to forward an XNet message sent to the layout.void
message(XNetReply msg)
Member function that will be invoked by an XNetInterface implementation to forward an XNet message from the layout.void
notifyTimeout(XNetMessage msg)
Member function invoked by an XNetInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.
-
-
-
Constructor Detail
-
XNetHeartBeat
public XNetHeartBeat(XNetSystemConnectionMemo memo)
-
-
Method Detail
-
dispose
public void dispose()
-
message
public void message(XNetReply msg)
Member function that will be invoked by an XNetInterface implementation to forward an XNet message from the layout.- Specified by:
message
in interfaceXNetListener
- Parameters:
msg
- The received XNet message. Note that this same object may be presented to multiple users. It should not be modified here.
-
message
public void message(XNetMessage msg)
Member function that will be invoked by an XNetInterface implementation to forward an XNet message sent to the layout. Normally, this function will do nothing.- Specified by:
message
in interfaceXNetListener
- Parameters:
msg
- The received XNet message. Note that this same object may be presented to multiple users. It should not be modified here.
-
notifyTimeout
public void notifyTimeout(XNetMessage msg)
Member function invoked by an XNetInterface implementation to notify a sender that an outgoing message timed out and was dropped from the queue.- Specified by:
notifyTimeout
in interfaceXNetListener
- Parameters:
msg
- message which has timed out.
-
-