net.happybrackets.core.scheduling

Class Delay

java.lang.Object

net.happybrackets.core.scheduling.Delay

All Implemented Interfaces:

ScheduledEventListener

public class Delay
extends java.lang.Object
implements ScheduledEventListener

Delay Class that uses HBScheduler You can use a delay to schedule an event to occur at some time in the future. For example, if we wanted to turn GPIO on for 5 seconds, we might use the following code:

 final int GPIO_OUTPUT = 23;
 GPIODigitalOutput outputPin = GPIODigitalOutput.getOutputPin(GPIO_OUTPUT);

 if (outputPin != null) {
     outputPin.setState(true);

     // now we will turn it off after 5 seconds
     new Delay(5000, outputPin, (delay_offset, param) - > {
         // delay_offset is how far out we were from our exact delay time in ms and is a double
         // param is the parameter we passed in, which was the output pin
         ((GPIODigitalOutput) o).setState(false);
     });
 }
 

More detail is in Delay.DelayListener.delayComplete(double, Object)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Delay.DelayListener DelayReceived interface for receiving delay complete.

Constructor Summary

Constructors

Constructor and Description
Delay(double interval, java.lang.Object param, Delay.DelayListener listener) Constructor using default Scheduler.
Delay(double interval, java.lang.Object param, Delay.DelayListener listener, HBScheduler scheduler) Constructor using an independent HBScheduler.

Method Summary

Modifier and Type	Method and Description
void	doScheduledEvent(double scheduledTime, java.lang.Object param) Notification interface that a scheduled event is occuring
boolean	isRunning() See if delay object is pending
void	stop() Cancel the delay event and stop it from occurring.

Methods inherited from class java.lang.Object

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

Constructor Detail

Delay

public Delay(double interval,
             java.lang.Object param,
             Delay.DelayListener listener)

Constructor using default Scheduler. if we wanted to turn GPIO on for 5 seconds, we might use the following code:

    final int GPIO_OUTPUT = 23;
    GPIODigitalOutput outputPin = GPIODigitalOutput.getOutputPin(GPIO_OUTPUT);

    if (outputPin != null) {
        outputPin.setState(true);

        // now we will turn it off after 5 seconds
        new Delay(5000, outputPin, (delay_offset, param) - > {
            // delay_offset is how far out we were from our exact delay time in ms and is a double
            // param is the parameter we passed in, which was the output pin
            ((GPIODigitalOutput) o).setState(false);
        });
    }
     

Parameters:

interval - the interval in milliseconds.

param - the parameter we want t pass back when our delay has completed

listener - the Delay.DelayListener to receive the callback when delay has finished

Delay

public Delay(double interval,
             java.lang.Object param,
             Delay.DelayListener listener,
             HBScheduler scheduler)

Constructor using an independent HBScheduler. Specifics about delay constructor are in Delay(double, Object, DelayListener)

Parameters:

interval - the interval in milliseconds If less than zero, the delay will call back on next schedule update

param - the parameter we want t pass back when our delay has completed

listener - the Delay.DelayListener to receive the callback when delay has finished

scheduler - the HBScheduler to use

Method Detail

doScheduledEvent

public void doScheduledEvent(double scheduledTime,
                             java.lang.Object param)

Description copied from interface: ScheduledEventListener

Notification interface that a scheduled event is occuring

Specified by:

doScheduledEvent in interface ScheduledEventListener

Parameters:

scheduledTime - the time that was scheduled for the callback to occur

param - the parameter to pass to the listener.

isRunning

public boolean isRunning()

See if delay object is pending

Returns:

true if a pending item is scheduled

stop

public void stop()

Cancel the delay event and stop it from occurring. For example, if we had a delay schedule for 50 seconds in the future and we wanted to cancel it before it completed, we could do the following:

     // This delay will take 50 seconds
     Delay longdelay = new Delay(50000, null, (delay_offset, param) - > {
         // delay_offset is how far out we were from our exact delay time in ms and is a double
         // param is the parameter we passed in type your code below this line
         System.out.println("Delay Complete");
         // type your code above this line
     });

     // 30 seconds in the future - we will stop longdelay completing
     longdelay.stop();