org.vishia.event

Interface EventTimerThread_ifc

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, EventThread_ifc, InfoAppend

All Known Implementing Classes:

EventTimerThread, OrderListExecuter

public interface EventTimerThread_ifc
extends EventThread_ifc

This interface should only be used for an alternative implementation of a event thread. The methods are used by the event processing. Of this package.

Field Summary

Fields inherited from interface org.vishia.util.InfoAppend

version

Method Summary

Modifier and Type	Method and Description
char	addTimeEntry(TimeOrder entry) Adds a timeout event or a time order with given execution time.
boolean	removeTimeEntry(TimeOrder entry) Removes a time order, which was activated but it is not in the event execution queue.

Methods inherited from interface org.vishia.event.EventThread_ifc

isBusy, isCurrentThread, removeFromQueue, storeEvent

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.vishia.util.InfoAppend

infoAppend

Method Detail

addTimeEntry

char addTimeEntry(TimeOrder entry)

Adds a timeout event or a time order with given execution time. The time should be set in the event already using its method TimeOrder.activateAt(long) etc. That routines calls this method internally already. Therefore this method should not be called by an application directly. It is only a rule to implement.

Parameters:

entry -

Returns:

a character only for test:
'n' notified, an earlier time.
'b' timer thread is yet busy, not notified
'l' time is later, not notified
'x' time is expired, executed yet

removeTimeEntry

boolean removeTimeEntry(TimeOrder entry)

Removes a time order, which was activated but it is not in the event execution queue. If the time order is expired and it is in the event execution queue already, it is not removed. This operation is thread safe. Either the event is found and removed, or it is not found because it is either in execution yet or it is not queued.

Parameters:

order - the timeout event or the time order.