eu.baltrad.beast.rules.timer.ITimeoutRule Interface Reference

Any rule implementing this interface can subscribe for a timeout notification. More...

Inheritance diagram for eu.baltrad.beast.rules.timer.ITimeoutRule:

Public Member Functions
IBltMessage	timeout (long id, int why, Object data)
	Will be triggered when a timeout occurs or any other reason that can be of interest, like the timeout has been cancelled.
Public Member Functions inherited from eu.baltrad.beast.rules.IRuleRecipientAware
void	setRecipients (List< String > recipients)

Static Public Attributes
static final int	TIMEOUT = 0
	Timeout was triggered due to timeout.
static final int	CANCELLED = 1
	Timeout was triggered due to cancellation.

Detailed Description

Any rule implementing this interface can subscribe for a timeout notification.

Author

Anders Henja

Member Function Documentation

timeout()

IBltMessage eu.baltrad.beast.rules.timer.ITimeoutRule.timeout	(	long	id,
		int	why,
		Object	data )

Will be triggered when a timeout occurs or any other reason that can be of interest, like the timeout has been cancelled.

Parameters

id	the identifier
why	the reason
data	any data that was registered with the timeout

Returns

a blt message if a message should be sent

Implemented in eu.baltrad.beast.rules.composite.CompositingRule, and eu.baltrad.beast.rules.volume.VolumeRule.

Member Data Documentation

CANCELLED

final int eu.baltrad.beast.rules.timer.ITimeoutRule.CANCELLED = 1

static

Timeout was triggered due to cancellation.

TIMEOUT

final int eu.baltrad.beast.rules.timer.ITimeoutRule.TIMEOUT = 0

static

Timeout was triggered due to timeout.

---

The documentation for this interface was generated from the following file:

• src/eu/baltrad/beast/rules/timer/ITimeoutRule.java