net.happybrackets.core.scheduling

Class DeviceStratumMessage

java.lang.Object

net.happybrackets.core.scheduling.DeviceStratumMessage

All Implemented Interfaces:

CustomGlobalEncoder

public class DeviceStratumMessage
extends java.lang.Object
implements CustomGlobalEncoder

Contains the parameters that define the DeviceStratumMessage time for a device.
The parameters stored are

• unique deviceName, eg HB-123456
• stratum, an index as to how close this device is to the domain time. The device with the lowest stratum is considered the reference time. If a device is synchronised using an NTP server, then it should have a lower value stratum than one without

Constructor Summary

Constructors

Constructor and Description
DeviceStratumMessage() Default constructor required for restore
DeviceStratumMessage(java.lang.Object... args) Restore data from an array of objects encoded through the encodeGlobalMessage functionn
DeviceStratumMessage(java.lang.String deviceName, int stratum) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.Object[]	encodeGlobalMessage()
boolean	equals(java.lang.Object other)
DeviceStratumMessage	restore(java.lang.Object restore_data) Decode the data based on how it is encoded.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeviceStratumMessage

public DeviceStratumMessage(java.lang.Object... args)

Restore data from an array of objects encoded through the encodeGlobalMessage functionn

Parameters:

args - the Object [] arguments

DeviceStratumMessage

public DeviceStratumMessage(java.lang.String deviceName,
                            int stratum)

Constructor

Parameters:

deviceName - unique deviceName, eg HB-123456

stratum - an index as to how close this device is to the domain time.

DeviceStratumMessage

public DeviceStratumMessage()

Default constructor required for restore

Method Detail

encodeGlobalMessage

public java.lang.Object[] encodeGlobalMessage()

Specified by:

encodeGlobalMessage in interface CustomGlobalEncoder

restore

public DeviceStratumMessage restore(java.lang.Object restore_data)

Description copied from interface: CustomGlobalEncoder

Decode the data based on how it is encoded. If the data is not encoded, then it will be returned as is

Specified by:

restore in interface CustomGlobalEncoder

Parameters:

restore_data - the encoded or decoded data

Returns:

the decoded object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object