net.happybrackets.core.scheduling

Class DeviceSchedulerValue

java.lang.Object

net.happybrackets.core.scheduling.DeviceSchedulerValue

All Implemented Interfaces:

java.lang.Comparable, CustomGlobalEncoder

public class DeviceSchedulerValue
extends java.lang.Object
implements CustomGlobalEncoder, java.lang.Comparable

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

• unique deviceName, eg HB-123456
• uptime, eg the JVM uptime from when device started
• scheduler time, the time that the device's global HBScheduler has it's time set to
• 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
DeviceSchedulerValue() Default constructor required for restore
DeviceSchedulerValue(java.lang.Object... args) Restore data from an array of objects encoded through the encodeGlobalMessage functionn
DeviceSchedulerValue(java.lang.String deviceName, double upTime, double schedulerTime, int stratum) Constructor

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o)
boolean	copyValues(DeviceSchedulerValue right) Copy the primitive types within the object.
java.lang.Object[]	encodeGlobalMessage()
boolean	equals(java.lang.Object other)
double	estimateSchedulerTime(double jvm_time) Estimate what the device's HBScheduler time will be based on what it was set to when received.
java.lang.String	getDeviceName() The device name of the device this represents
double	getLastUpdateJVMTime() The last JVM time of THIS device in milliseconds that we received a message from the device that this object represents
double	getSchedulerTime() The time that the HBScheduler of the device this represents has it's time set to
int	getStratum() The Stratum of the device this represents
double	getUpTime() The JVM uptime of the device this represents in milliseconds
DeviceSchedulerValue	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

DeviceSchedulerValue

public DeviceSchedulerValue()

Default constructor required for restore

DeviceSchedulerValue

public DeviceSchedulerValue(java.lang.String deviceName,
                            double upTime,
                            double schedulerTime,
                            int stratum)

Constructor

Parameters:

deviceName - unique deviceName, eg HB-123456

upTime - the JVM uptime from when device started

schedulerTime - the time that the device has it's schedule set at the uptime

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

DeviceSchedulerValue

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

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

Parameters:

args - the Object [] arguments

Method Detail

copyValues

public boolean copyValues(DeviceSchedulerValue right)

Copy the primitive types within the object. Using this to reduce fragmentation

Parameters:

right - the object we are copying from.

Returns:

true if it will change the sort comparator value

estimateSchedulerTime

public double estimateSchedulerTime(double jvm_time)

Estimate what the device's HBScheduler time will be based on what it was set to when received.

Parameters:

jvm_time - the current JVM time on THIS device

Returns:

the estimated HBScheduler time of the device we are examining

encodeGlobalMessage

public java.lang.Object[] encodeGlobalMessage()

Specified by:

encodeGlobalMessage in interface CustomGlobalEncoder

restore

public DeviceSchedulerValue 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

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

getDeviceName

public java.lang.String getDeviceName()

The device name of the device this represents

Returns:

Device Name

getUpTime

public double getUpTime()

The JVM uptime of the device this represents in milliseconds

Returns:

JVM uptime

getSchedulerTime

public double getSchedulerTime()

The time that the HBScheduler of the device this represents has it's time set to

Returns:

the HBScheduler time of device

getStratum

public int getStratum()

The Stratum of the device this represents

Returns:

the stratum of the device

getLastUpdateJVMTime

public double getLastUpdateJVMTime()

The last JVM time of THIS device in milliseconds that we received a message from the device that this object represents

Returns:

the JVM time of THIS Device when last message was received