Package io.openems.backend.alerting.scheduler

Class Scheduler

java.lang.Object

io.openems.backend.alerting.scheduler.Scheduler

All Implemented Interfaces:

MessageSchedulerService, TimedExecutor, Consumer<ZonedDateTime>

public class Scheduler
extends Object
implements Consumer<ZonedDateTime>, MessageSchedulerService, TimedExecutor

A MessageSchedulerService implementation using MinuteTimer.

Nested Class Summary

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

TimedExecutor.TimedTask

Constructor Summary

Constructors

Constructor	Description
Scheduler()
Scheduler(MinuteTimer timer)

Method Summary

Modifier and Type	Method	Description
void	accept(ZonedDateTime now)
void	cancel(TimedExecutor.TimedTask task)	Cancel TimedExecutor.TimedTask.
int	getScheduledMsgsCount()	Get the total count of Messages scheduled for dispatch.
boolean	isScheduled(Message msg)	Check if given message is scheduled within any MessageScheduler.
ZonedDateTime	now()	Get the Executors current ZonedDateTime.
<T extends Message> MessageScheduler<T>	register(Handler<T> handler)	Register handler for message scheduling and return MessageScheduler, to do so.
TimedExecutor.TimedTask	schedule(ZonedDateTime at, Consumer<ZonedDateTime> task)	Execute the given task at the given dateTime.
void	start()	Subscribe to minuteTimer and start scheduling.
void	stop()	Unsubscribe from minuteTimer and stop scheduling.
<T extends Message> void	unregister(Handler<T> handler)	Unregister handler for message scheduling and remove MessageScheduler.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Details

Scheduler

public Scheduler(MinuteTimer timer)

Scheduler

public Scheduler()

Method Details

register

public <T extends Message> MessageScheduler<T> register(Handler<T> handler)

Description copied from interface: MessageSchedulerService

Register handler for message scheduling and return MessageScheduler, to do so.

Specified by:

register in interface MessageSchedulerService

Type Parameters:

T - type of message

Parameters:

handler - to register

Returns:

new MessageScheduler for handler to schedule messages with

unregister

public <T extends Message> void unregister(Handler<T> handler)

Description copied from interface: MessageSchedulerService

Unregister handler for message scheduling and remove MessageScheduler.

Specified by:

unregister in interface MessageSchedulerService

Type Parameters:

T - type of message

Parameters:

handler - to unregister

schedule

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

Description copied from interface: TimedExecutor

Execute the given task at the given dateTime.

Specified by:

schedule in interface TimedExecutor

Parameters:

at - time to execute at

task - task to execute

Returns:

reference to Task as TimedExecutor.TimedTask Can be used to cancel the task.

cancel

public void cancel(TimedExecutor.TimedTask task)

Description copied from interface: TimedExecutor

Cancel TimedExecutor.TimedTask.

Specified by:

cancel in interface TimedExecutor

Parameters:

task - to remove

now

public ZonedDateTime now()

Description copied from interface: TimedExecutor

Get the Executors current ZonedDateTime. Should be used to calculate execution time.

Specified by:

now in interface TimedExecutor

Returns:

current ZonedDateTime

start

public void start()

Subscribe to minuteTimer and start scheduling.

stop

public void stop()

Unsubscribe from minuteTimer and stop scheduling.

getScheduledMsgsCount

public int getScheduledMsgsCount()

Get the total count of Messages scheduled for dispatch.

Returns:

total count

isScheduled

public boolean isScheduled(Message msg)

Check if given message is scheduled within any MessageScheduler.

Parameters:

msg - to check for

Returns:

true if any scheduling was found

accept

public void accept(ZonedDateTime now)

Specified by:

accept in interface Consumer<ZonedDateTime>