net.happybrackets.core.scheduling

Class DeviceSchedules

java.lang.Object

net.happybrackets.core.scheduling.DeviceSchedules

public class DeviceSchedules
extends java.lang.Object

Singleton class for containing inter-device scheduling

Method Summary

Modifier and Type	Method and Description
void	addGlobalScheduleAdvertiseListener(OSCVocabulary.OSCAdvertiseListener listener)
java.util.List<DeviceSchedulerValue>	getDeviceSchedulerValues() Get the list of all scheduled devices we have listed
static DeviceSchedules	getInstance()
DeviceSchedulerValue	getLeadingDevice() Get the device that is listed as the first device in our list
boolean	isLeadDevice() See if we are the current leading device on synchroniser network
int	numberDevices() Return the number of devices synchonising on network
void	processCurrentMessage(java.lang.String source, DeviceSchedulerValue value) Process reception of a DeviceSchedule message
boolean	processStratumMessage(DeviceStratumMessage message) Process a stratum message to advise us we should change our stratum
boolean	removeExpiredLead(long expiration_millisecond) If the Device marked as the lead device has not been heard for a certain time, we will remove it from our list
boolean	sendCurrentTime() Send the current Scheduler information about this device
double	timeRange() Return the range of time in milliseconds between the maximum and minimum scheduled times
float	totalDiscardCount() Get the total discards for all devices

Methods inherited from class java.lang.Object

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

Method Detail

addGlobalScheduleAdvertiseListener

public void addGlobalScheduleAdvertiseListener(OSCVocabulary.OSCAdvertiseListener listener)

isLeadDevice

public boolean isLeadDevice()

See if we are the current leading device on synchroniser network

Returns:

true if this is the device that others are synchronising to

numberDevices

public int numberDevices()

Return the number of devices synchonising on network

Returns:

number devices

getInstance

public static DeviceSchedules getInstance()

sendCurrentTime

public boolean sendCurrentTime()

Send the current Scheduler information about this device

Returns:

true if able to send

totalDiscardCount

public float totalDiscardCount()

Get the total discards for all devices

Returns:

to total of all discards

processStratumMessage

public boolean processStratumMessage(DeviceStratumMessage message)

Process a stratum message to advise us we should change our stratum

Parameters:

message - the message containing stratum

Returns:

true if we changed our stratum

processCurrentMessage

public void processCurrentMessage(java.lang.String source,
                                  DeviceSchedulerValue value)

Process reception of a DeviceSchedule message

Parameters:

source - the source device that has sent this message

value - the DeviceSchedulerValue message received

getDeviceSchedulerValues

public java.util.List<DeviceSchedulerValue> getDeviceSchedulerValues()

Get the list of all scheduled devices we have listed

Returns:

the list of all DeviceSchedulerValue we have stored

timeRange

public double timeRange()

Return the range of time in milliseconds between the maximum and minimum scheduled times

Returns:

the difference between the minimum estimated schedule and maximum estimated scheduled times

removeExpiredLead

public boolean removeExpiredLead(long expiration_millisecond)

If the Device marked as the lead device has not been heard for a certain time, we will remove it from our list

Parameters:

expiration_millisecond - the amount of milliseconds that must expire before we decide to remove it

Returns:

true if a device was removed

getLeadingDevice

public DeviceSchedulerValue getLeadingDevice()

Get the device that is listed as the first device in our list

Returns:

the Front device