Package io.openems.backend.alerting.scheduler

Class MinuteTimer

java.lang.Object

io.openems.backend.alerting.scheduler.MinuteTimer

All Implemented Interfaces:

TimedExecutor

Direct Known Subclasses:

MinuteTimerAsync

public class MinuteTimer
extends Object
implements TimedExecutor

Executes subscriber every full Minute or once after a specified time of Minutes. Starts and stops itself, depending on whether subscribers are present.

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.backend.alerting.scheduler.TimedExecutor

TimedExecutor.TimedTask

Constructor Summary

Constructors

Constructor	Description
MinuteTimer(Clock clock)	Create MinuteTimer with given clock.

Method Summary

Modifier and Type	Method	Description
void	cancel(TimedExecutor.TimedTask task)	Cancel task.
protected void	cycle()
int	getSubscriberCount()
ZonedDateTime	now()	Get the current ZonedDateTime for the Clock this MinuteTimer works with.
TimedExecutor.TimedTask	schedule(ZonedDateTime at, Consumer<ZonedDateTime> task)	Execute the given task at the given dateTime to the minute.
protected void	start()
protected void	stop()
void	subscribe(Consumer<ZonedDateTime> sub)	Add subscriber for every minute execution.
void	unsubscribe(Consumer<ZonedDateTime> sub)	Remove subscriber from every minute execution.

Methods inherited from class java.lang.Object

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

Constructor Details

MinuteTimer

public MinuteTimer(Clock clock)

Create MinuteTimer with given clock.

Parameters:

clock - to use for timing

Method Details

subscribe

public void subscribe(Consumer<ZonedDateTime> sub)

Add subscriber for every minute execution.

Parameters:

sub - to add

unsubscribe

public void unsubscribe(Consumer<ZonedDateTime> sub)

Remove subscriber from every minute execution.

Parameters:

sub - to remove

schedule

public TimedExecutor.TimedTask schedule(ZonedDateTime at,
 Consumer<ZonedDateTime> task)

Execute the given task at the given dateTime to the minute.

Specified by:

schedule in interface TimedExecutor

Parameters:

at - time to execute at

task - task to execute

Returns:

reference to Task. Can be used to cancel the task.

cancel

public void cancel(TimedExecutor.TimedTask task)

Cancel task.

Specified by:

cancel in interface TimedExecutor

Parameters:

task - to remove

start

protected void start()

cycle

protected void cycle()

stop

protected void stop()

getSubscriberCount

public int getSubscriberCount()

now

public ZonedDateTime now()

Get the current ZonedDateTime for the Clock this MinuteTimer works with.

Specified by:

now in interface TimedExecutor

Returns:

ZonedDateTime now