Package io.openems.common.worker

Class AbstractWorker

java.lang.Object

io.openems.common.worker.AbstractWorker

Direct Known Subclasses:

AbstractCycleWorker, AbstractImmediateWorker, AppInstallWorker, AppSynchronizeWorker, AppValidateWorker, ClientReconnectorWorker, ComponentManagerWorker, CycleWorker, DiskSpaceWorker, NetworkConfigurationWorker, ReadWorker, UsbConfigurationWorker

public abstract class AbstractWorker
extends Object

Defines a generic Worker Thread.

The business logic of the Worker is inside the forever() method. It is executed by default every getCycleTime() seconds. Additionally execution can be triggered by calling the triggerNextRun() method.

If Cycle-Time is negative (e.g. by using ALWAYS_WAIT_FOR_TRIGGER_NEXT_RUN) the forever() method is called only after triggering it.

If Cycle-Time is zero (e.g. by using DO_NOT_WAIT), the forever() method is always called immediately without any delay.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALWAYS_WAIT_FOR_TRIGGER_NEXT_RUN
static final int	DO_NOT_WAIT
protected final Thread	thread

Constructor Summary

Constructors

Constructor	Description
AbstractWorker()

Method Summary

Modifier and Type	Method	Description
void	activate(String name)	Initializes the worker and starts the worker thread.
void	deactivate()	Stops the worker thread.
protected abstract void	forever()	This method is called in a loop forever until the Thread gets interrupted.
protected abstract int	getCycleTime()	Gets the cycleTime of this worker in [ms].
void	modified(String name)	Modifies the worker thread.
void	triggerNextRun()	Allows the next execution of the forever() method.

Methods inherited from class java.lang.Object

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

Field Details

ALWAYS_WAIT_FOR_TRIGGER_NEXT_RUN

public static final int ALWAYS_WAIT_FOR_TRIGGER_NEXT_RUN

See Also:

• Constant Field Values

DO_NOT_WAIT

public static final int DO_NOT_WAIT

See Also:

• Constant Field Values

thread

protected final Thread thread

Constructor Details

AbstractWorker

public AbstractWorker()

Method Details

activate

public void activate(String name)

Initializes the worker and starts the worker thread.

Parameters:

name - the name of the worker thread

modified

public void modified(String name)

Modifies the worker thread.

Parameters:

name - the name of the worker thread

deactivate

public void deactivate()

Stops the worker thread.

forever

protected abstract void forever()
                         throws Throwable

This method is called in a loop forever until the Thread gets interrupted.

Throws:

Throwable

getCycleTime

protected abstract int getCycleTime()

Gets the cycleTime of this worker in [ms].

• > 0 sets the minimum execution time of one Cycle
• = 0 never wait between two consecutive executions of forever()
• < 0 causes the Cycle to sleep forever until 'triggerNextRun()' is called

Returns:

the cycleTime

triggerNextRun

public void triggerNextRun()

Allows the next execution of the forever() method.