javax.realtime

Class AsyncObjectEvent<P>

java.lang.Object

javax.realtime.AsyncBaseEvent

javax.realtime.AsyncObjectEvent<P>

public class AsyncObjectEvent<P>
extends AsyncBaseEvent

An event that carries a Object as payload

Since:

RTSJ 2.0

See Also:

AsyncEvent

Constructor Summary

Constructors

Constructor and Description
AsyncObjectEvent() Creates a new AsyncObjectEvent object.

Method Summary

Modifier and Type	Method and Description
void	fire(P value) When enabled, releases the handlers associated with this instance of AsyncObjectEvent with the P passed by fire(Object).

Methods inherited from class javax.realtime.AsyncBaseEvent

addHandler, createReleaseParameters, disable, enable, finalize, handledBy, hasHandlers, isRunning, removeHandler, setHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncObjectEvent

public AsyncObjectEvent()

Creates a new AsyncObjectEvent object.

Method Detail

fire

public void fire(P value)
          throws MITViolationException,
                 EventQueueOverflowException

When enabled, releases the handlers associated with this instance of AsyncObjectEvent with the P passed by fire(Object). When no handlers are attached or this object is disabled the method does nothing, i.e., it skips the release.

• When the instance of AsyncObjectEvent is associated with more than one instance of AsyncObjectEventHandler with release parameters object of type AperiodicParameters and the execution of fire(Object) introduces the requirement to throw at least one type of exception, then all instances of AsyncObjectEventHandler not affected by the exception are handled normally.
• When this instance of AsyncObjectEvent is associated with more than one instance of AsyncObjectEventHandler with release parameters object of type SporadicParameters and the execution of fire(Object) introduces the simultaneous requirement to throw more than one type of exception or error, then MITViolationException has precedence over ArrivalTimeQueueOverflowException.

Throws:

MITViolationException - under the base priority scheduler's semantics, when there is a handler associated with this event that has its MIT violated by the call to fire (and it has set the minimum inter-arrival time violation behavior to MITViolationExcept). Only the handlers which do not have their MITs violated are released in this situation.

EventQueueOverflowException - when the queue of release information, arrival time and payload, overflows. Only the handlers which do not cause this exception to be thrown are released in this situation. When fire is called from the infrastructure, such as for an ActiveEvent, this exception is ignored.

StaticUnsupportedOperationException - when used with an AsyncObjectEventHandler, since that class is not yet implemented.

Parameters:

value - The payload passed to the event.