io.openems.common.worker

Class AbstractWorker

java.lang.Object

io.openems.common.worker.AbstractWorker

Direct Known Subclasses:

AbstractCycleWorker, AbstractImmediateWorker, ClientReconnectorWorker, ComponentManagerWorker, CycleWorker, HostWorker, ReadWorker

public abstract class AbstractWorker
extends java.lang.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 and Description
static int	ALWAYS_WAIT_FOR_TRIGGER_NEXT_RUN
static int	DO_NOT_WAIT

Constructor Summary

Constructors

Constructor and Description
AbstractWorker()

Method Summary

Modifier and Type	Method and Description
void	activate(java.lang.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	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 Detail

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

Constructor Detail

AbstractWorker

public AbstractWorker()

Method Detail

activate

public void activate(java.lang.String name)

Initializes the worker and starts the worker thread

Parameters:

name -

deactivate

public void deactivate()

Stops the worker thread

forever

protected abstract void forever()
                         throws java.lang.Throwable

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

Throws:

java.lang.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:

triggerNextRun

public void triggerNextRun()

Allows the next execution of the forever() method.