javax.safetycritical

Class PeriodicEventHandler

java.lang.Object

javax.safetycritical.ManagedEventHandler

javax.safetycritical.PeriodicEventHandler

All Implemented Interfaces:

ManagedSchedulable

@SCJAllowed
public abstract class PeriodicEventHandler
extends ManagedEventHandler

This class permits the automatic periodic execution of code. The handleAsyncEvent method behaves as if the handler were attached to a periodic asynchronous event.

This class is abstract, non-abstract sub-classes must implement the method handleAsyncEvent and may override the default cleanUp method. Note that the values in parameters passed to the constructors are those that will be used by the infrastructure. Changing these values after construction will have no impact on the created event handler.

Version:

1.2; - December 2013

Author:

Anders P. Ravn, Aalborg University, apr@cs.aau.dk,
Hans Søndergaard, VIA University College, Denmark, hso@via.dk

Relative_to_SCJ_Draft_Version_0.94:

- SCJ issue: One constructor only.

Constructor Summary

Constructors

Constructor and Description
PeriodicEventHandler(PriorityParameters priority, PeriodicParameters release, StorageParameters storage) Constructs a periodic event handler.

Method Summary

Methods

Modifier and Type	Method and Description
void	register() Registers this event handler with the current mission.

Methods inherited from class javax.safetycritical.ManagedEventHandler

cleanUp, getLastReleaseTime, handleAsyncEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodicEventHandler

public PeriodicEventHandler(PriorityParameters priority,
                    PeriodicParameters release,
                    StorageParameters storage)

Constructs a periodic event handler.

Parameters:

priority - specifies the priority parameters for this periodic event handler. Must not be null.

release - specifies the periodic release parameters, in particular the start time, period and deadline miss handler. Note that a relative start time is not relative to now, rather it is relative to the point in time when initialization is finished and the timers are started. This argument must not be null.

storage - specifies the storage parameters for the periodic event handler. It must not be null.

Throws:

java.lang.IllegalArgumentException - if priority, release or storage is null.

Method Detail

register

public final void register()

Description copied from class: ManagedEventHandler

Registers this event handler with the current mission.

Specified by:

register in interface ManagedSchedulable

Overrides:

register in class ManagedEventHandler