com.ergotech.secs

Class LinkTest

java.lang.Object

com.ergotech.secs.LinkTest

All Implemented Interfaces:

SecsEventListener, java.lang.Runnable, java.util.EventListener

public class LinkTest
extends java.lang.Object
implements java.lang.Runnable, SecsEventListener

This object will send HSMS Link Tests periodically.

Field Summary

Fields inherited from interface com.ergotech.secs.SecsEventListener

cvsRev

Constructor Summary

Constructors

Constructor and Description
LinkTest() The constructor.
LinkTest(HSMSSessionManager hsmsSessionManager) The constructor.

Method Summary

Modifier and Type	Method and Description
double	getSpacing() Returns the current spacing between messages in seconds.
void	run() This will run until there is an error or the spacing is set to zero or less.
void	secsEvent(SecsEvent theEvent) This method will be called when a SecsEvent accurs.
void	sendOnce() Sends one link test message.
void	setSpacing(double spacing) Sets the spacing, this will also start the messages sending if necessary.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinkTest

public LinkTest()
         throws SecsException

The constructor.

Throws:

SecsException

LinkTest

public LinkTest(HSMSSessionManager hsmsSessionManager)

The constructor.

Method Detail

getSpacing

public double getSpacing()

Returns the current spacing between messages in seconds.

run

public void run()

This will run until there is an error or the spacing is set to zero or less.

Specified by:

run in interface java.lang.Runnable

secsEvent

public void secsEvent(SecsEvent theEvent)

Description copied from interface: SecsEventListener

This method will be called when a SecsEvent accurs.

Specified by:

secsEvent in interface SecsEventListener

sendOnce

public void sendOnce()
              throws SecsException

Sends one link test message.

Throws:

SecsException

setSpacing

public void setSpacing(double spacing)

Sets the spacing, this will also start the messages sending if necessary. This parameter will not take effect until after the next message is sent. This value is in seconds.