javax.realtime

Class AsyncLongEventHandler

java.lang.Object

javax.realtime.AsyncBaseEventHandler

javax.realtime.AsyncLongEventHandler

All Implemented Interfaces:

java.lang.Runnable, Schedulable, Subsumable<Schedulable>

Direct Known Subclasses:

BoundAsyncLongEventHandler

public class AsyncLongEventHandler
extends AsyncBaseEventHandler

A version of AsyncBaseEventHandler that carries a long value as payload.

Since:

RTSJ 2.0

Constructor Summary

Constructors

Constructor and Description
AsyncLongEventHandler() Creates an instance of AsyncLongEventHandler (ALEH) with default values for all parameters.
AsyncLongEventHandler(java.util.function.LongConsumer logic) Calling this constructor is equivalent to calling AsyncLongEventHandler(SchedulingParameters, ReleaseParameters, MemoryParameters, MemoryArea, ConfigurationParameters, ReleaseRunner, LongConsumer) with arguments (null, null, null, null, null, null, logic).
AsyncLongEventHandler(SchedulingParameters scheduling, ReleaseParameters<?> release) Calling this constructor is equivalent to calling AsyncLongEventHandler(SchedulingParameters, ReleaseParameters, MemoryParameters, MemoryArea, ConfigurationParameters, ReleaseRunner, LongConsumer) with arguments (scheduling, release, null, null, null, null, null)
AsyncLongEventHandler(SchedulingParameters scheduling, ReleaseParameters<?> release, java.util.function.LongConsumer logic) Calling this constructor is equivalent to calling AsyncLongEventHandler(SchedulingParameters, ReleaseParameters, MemoryParameters, MemoryArea, ConfigurationParameters, ReleaseRunner, LongConsumer) with arguments (scheduling, release, null, null, null, null, logic).
AsyncLongEventHandler(SchedulingParameters scheduling, ReleaseParameters<?> release, MemoryParameters memory, MemoryArea area, ConfigurationParameters config, ReleaseRunner runner, java.util.function.LongConsumer logic) Creates an asynchronous event handler that receives a Long payload with each fire.

Method Summary

Modifier and Type	Method and Description
void	handleAsyncEvent(long payload) This method holds the logic which is to be executed when any AsyncEvent with which this handler is associated is fired.
long	peekPending() Determines the next value queued for handling.
void	release(long payload) Release this handler now.

Methods inherited from class javax.realtime.AsyncBaseEventHandler

addToFeasibility, getAndClearPendingFireCount, getAndDecrementPendingFireCount, getConfigurationParameters, getCurrentReleaseTime, getCurrentReleaseTime, getMemoryArea, getMemoryParameters, getPendingFireCount, getProcessingGroupParameters, getQueueLength, getReleaseParameters, getReleaseRunner, getScheduler, getSchedulingParameters, isArmed, isDaemon, mayUseHeap, removeFromFeasibility, run, setDaemon, setMemoryParameters, setProcessingGroupParameters, setReleaseParameters, setScheduler, setScheduler, setSchedulingParameters, setSchedulingParametersIfFeasible, subsumes

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncLongEventHandler

public AsyncLongEventHandler(SchedulingParameters scheduling,
                             ReleaseParameters<?> release,
                             MemoryParameters memory,
                             MemoryArea area,
                             ConfigurationParameters config,
                             ReleaseRunner runner,
                             java.util.function.LongConsumer logic)
                      throws StaticIllegalArgumentException

Creates an asynchronous event handler that receives a Long payload with each fire.

Parameters:

scheduling - Parameter for scheduling the new handler (and possibly other instances of Schedulable). When scheduling is null and the creator is an instance of Schedulable, SchedulingParameters is a clone of the creator's value created in the same memory area as this. When scheduling is null and the creator is a task that is not an instance of Schedulable, the contents and type of the new SchedulingParameters object are governed by the associated scheduler.

release - Parameter for scheduling the new handler (and possibly other instances of Schedulable). When release is null the new AsyncEventHandler will use a clone of the default ReleaseParameters for the associated scheduler created in the memory area that contains the AsyncEventHandler object.

memory - Parameter for scheduling the new handler (and possibly other instances of Schedulable). When memory is null, the new AsyncEventHandler receives null value for its memory parameters, and the amount or rate of memory allocation for the new handler is unrestricted.

area - The initial memory area of this handler.

config - The configuration parameters for this handler.

runner - Logic to be executed by handleAsyncEvent(long)

logic - The logic to run for each fire. When logic is null, the handleAsyncEvent() method in the new object will serve as its logic.

Throws:

StaticIllegalArgumentException - when the event queue overflow policy is QueueOverflowPolicy.DISABLE.

AsyncLongEventHandler

public AsyncLongEventHandler(SchedulingParameters scheduling,
                             ReleaseParameters<?> release,
                             java.util.function.LongConsumer logic)
                      throws StaticIllegalArgumentException

Calling this constructor is equivalent to calling AsyncLongEventHandler(SchedulingParameters, ReleaseParameters, MemoryParameters, MemoryArea, ConfigurationParameters, ReleaseRunner, LongConsumer) with arguments (scheduling, release, null, null, null, null, logic).

Throws:

StaticIllegalArgumentException

AsyncLongEventHandler

public AsyncLongEventHandler(SchedulingParameters scheduling,
                             ReleaseParameters<?> release)
                      throws StaticIllegalArgumentException

Calling this constructor is equivalent to calling AsyncLongEventHandler(SchedulingParameters, ReleaseParameters, MemoryParameters, MemoryArea, ConfigurationParameters, ReleaseRunner, LongConsumer) with arguments (scheduling, release, null, null, null, null, null)

Throws:

StaticIllegalArgumentException

AsyncLongEventHandler

public AsyncLongEventHandler(java.util.function.LongConsumer logic)

Calling this constructor is equivalent to calling AsyncLongEventHandler(SchedulingParameters, ReleaseParameters, MemoryParameters, MemoryArea, ConfigurationParameters, ReleaseRunner, LongConsumer) with arguments (null, null, null, null, null, null, logic).

AsyncLongEventHandler

public AsyncLongEventHandler()

Creates an instance of AsyncLongEventHandler (ALEH) with default values for all parameters.

See Also:

AsyncLongEventHandler(SchedulingParameters, ReleaseParameters, MemoryParameters, MemoryArea, ConfigurationParameters, ReleaseRunner, LongConsumer)

Method Detail

handleAsyncEvent

public void handleAsyncEvent(long payload)

This method holds the logic which is to be executed when any AsyncEvent with which this handler is associated is fired. This method will be invoked repeatedly while fireCount_ is greater than zero.

The default implementation of this method either invokes the run method of the logic passed to the constructor of this handler, when it is an instance of Runnable or nothing, when logic is null.

This ALEH is a source of reference for its initial memory area while this ALEH is released.

All throwables from (or propagated through) handleAsyncEvent are caught, a stack trace is printed and execution continues as if handleAsyncEvent had returned normally.

Parameters:

payload - It is the long value associated with a fire.

peekPending

public long peekPending()
                 throws StaticIllegalStateException

Determines the next value queued for handling.

Returns:

the long value at the head of the queue of longs to be passed to handleAsyncEvent(long).

Throws:

StaticIllegalStateException - when the fire count is zero.

release

public void release(long payload)
             throws MITViolationException,
                    ArrivalTimeQueueOverflowException

Release this handler now. Perform the requested minimum interarrival time enforcement and arrival time queue overflow handling as specified in the release parameters.

Parameters:

payload - The data associated with the release.

Throws:

MITViolationException - iff the minimum interarrival time was not respected and the MIT-violation behavior is set to EXCEPT.

ArrivalTimeQueueOverflowException - if an overflow in the arrival time queue occurred and the arrival time queue overflow behavior is EXCEPT.