org.vishia.event

Class EventTimeout

java.lang.Object

java.util.EventObject

org.vishia.event.EventWithDst

org.vishia.event.EventTimeout

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TimeOrder

public class EventTimeout
extends EventWithDst

This class is a ready-to-use timeout event for state machines or the base class for time orders.
An EventTimeout is used inside StateMachine as persistent instance of a parallel state machine or of the top state if timeouts are used in the states.
Instantiation pattern:

   EventThread thread = new EventThread("stateThread");
   //uses the thread as timer manager and as event executer
   EventTimeout timeout = new EventTimeout(stateMachine, thread);
 

Activate the timeout event:

   timeout.activate(7000);  //in 7 seconds.
 

• Constructors: EventTimeout#EventTimeout(EventConsumer, EventTimerThread), EventTimeout().
• methods to activate: activate(int), activateAt(long), activateAt(long, long)
• Remove a currently timeout: deactivate()
• Check: timeExecution(), timeExecutionLatest(), timeToExecution() used()
• see TimeOrder.
• see EventTimerThread
• see StateMachine

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	dbgctWindup It is counted only.
private static long	serialVersionUID
protected long	timeExecution If not 0, it is the time to execute it.
protected long	timeExecutionLatest If not 0, it is the last time to execute it if the execution will be deferred by additional invocation of activateAt(long) while it is activated already.
static java.lang.String	version Version and history: 2015-01-02 Hartmut created: as super class of TimeOrder and as event for timeout for state machines.

Fields inherited from class org.vishia.event.EventWithDst

bAwaitReserve, ctConsumed, dateCreation, dateOrder, evDst, evDstThread, orderId, stateOfEvent, toStringDateFormat

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
EventTimeout() Creates an event as a static object for re-usage.
EventTimeout(EventConsumer consumer, EventTimerThread_ifc thread) Creates an event as static or dynamic object for usage.

Method Summary

Modifier and Type	Method and Description
void	activate(int millisec) Activate the event for the given laps of time.
void	activateAt(long date) Activates the timeout event to the given timestamp.
void	activateAt(long date, long latest) Activate the event at the given absolute time If the event is activated already for a shorter time, the activation time is deferred to this given time but not later than a latest time given with activateAt(long, long).
void	deactivate() Remove this from the queue of timer events and orders
protected void	doTimeElapsed() Processes the event or timeOrder.
long	timeExecution() Returns the time stamp where the time is elapsed
long	timeExecutionLatest() Returns the time stamp where the time is elapsed latest.
int	timeToExecution() Checks whether it should be executed.
boolean	used()

Methods inherited from class org.vishia.event.EventWithDst

consumed, dateCreation, evDst, getDst, getDstThread, hasDst, isOccupied, notifyDequeued, occupy, occupy, occupy, occupyRecall, occupyRecall, occupyRecall, occupyRecall, relinquish, removeFromQueue, sendEvent, setDst, setOrderId, XXXdonotRelinquish

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

Version and history:

• 2015-01-02 Hartmut created: as super class of TimeOrder and as event for timeout for state machines.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are indent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

timeExecution

protected long timeExecution

If not 0, it is the time to execute it. Elsewhere it should be delayed.

timeExecutionLatest

protected long timeExecutionLatest

If not 0, it is the last time to execute it if the execution will be deferred by additional invocation of activateAt(long) while it is activated already.

dbgctWindup

public int dbgctWindup

It is counted only. Used for debug. Possible to set.

Constructor Detail

EventTimeout

public EventTimeout()

Creates an event as a static object for re-usage. Use EventWithDst.occupy(EventSource, EventConsumer, EventTimerThread, boolean) before first usage. Use EventWithDst.relinquish() to release the usage. Usual the parameterized method EventTimeout#EventTimeout(EventSource, EventConsumer, EventThreadIfc) should be used.

EventTimeout

public EventTimeout(EventConsumer consumer,
                    EventTimerThread_ifc thread)

Creates an event as static or dynamic object for usage. See also EventWithDst#EventWithDst(EventSource, EventConsumer, EventThreadIfc) The timeout instance may be static usual (permanent referenced) and not allocated on demand (with new) because it is used whenever a special state is entered.

Parameters:

consumer - The destination object for the event. If it is null nothing will be executed if the event is expired.

thread - thread to handle the time order. It is obligatory.

Method Detail

activate

public void activate(int millisec)

Activate the event for the given laps of time. If the event is activated already for a shorter time, the activation time is deferred to this given time but not later than a latest time given with activateAt(long, long).

Parameters:

millisec - if a negative value or a value less then 3 is given the event is processed immediately.

See Also:

activateAt(long, long).

activateAt

public void activateAt(long date)

Activates the timeout event to the given timestamp. With this method the event or time order is enqueued in its thread given by construction.

Parameters:

date - The absolute time stamp in seconds after 1970 UTC like given with System.currentTimeMillis(). To set a relative time you must write

     myEvent.activateAt(System.currentTimeMillis() + delay);
   

activateAt

public void activateAt(long date,
                       long latest)

Activate the event at the given absolute time If the event is activated already for a shorter time, the activation time is deferred to this given time but not later than a latest time given with activateAt(long, long).

Parameters:

date - The time stamp.

latest - The latest time stamp where the event should be processed though it is deferred. If the event is activated already for a earlier latest time, this argument is ignored. The earlier latest time is valid. Use deactivate() before this method to set the latest processing time newly.

See Also:

activateAt(long, long).

deactivate

public void deactivate()

Remove this from the queue of timer events and orders

timeExecution

public long timeExecution()

Returns the time stamp where the time is elapsed

Returns:

milliseconds after 1970, 0 if the event is not activated yet.

timeExecutionLatest

public long timeExecutionLatest()

Returns the time stamp where the time is elapsed latest.

Returns:

milliseconds after 1970, 0 if the event is not activated yet.

used

public boolean used()

doTimeElapsed

protected final void doTimeElapsed()

Processes the event or timeOrder. This routine is called in the EventTimerThread if the time is elapsed.

If the EventWithDst.evDst() is given the EventConsumer.processEvent(java.util.EventObject) is called though this instance may be a timeOrder. This method can enqueue this instance in another queue for execution in any other thread which invokes then TimeOrder.doExecute().

It this is a TimeOrder and the #evDst is not given by constructor then the TimeOrder.doExecute() is called to execute the time order.

If this routine is started then an invocation of activate(int) etc. enqueues this instance newly with a new time for elapsing. It is executed newly therefore.

timeToExecution

public int timeToExecution()

Checks whether it should be executed.

Returns:

time in milliseconds for first execution or value <0 to execute immediately.