Holding updates

Detailed Description

The hold package allows a single update packet (see DSData Update Packets) to be cached and updated. This package is of use if you need to hold an update which has failed any validation. The validation package (see Validation) calls this package to provide an hold and automatic release functionality.

Functions
	hold.get (var symname)
	Get the currently held update. More...
	hold.release (var symname)
	Release the currently held update. More...
	hold.update (var symname, var update)
	Update the held packet with the most recent values. More...
	hold.kill (var symname)
	Kill the current held packet. More...

Function Documentation

hold.get

(

var

symname

)

Get the currently held update.

Parameters

symname

- Name of the symbol

Returns

The held update

Return values

nil	- No update currently held

This function uses the following db keys on the symbol:

HoldUpdate

hold.kill

(

var

symname

)

Kill the current held packet.

Parameters

symname

- Symbol name

Returns

Nothing

This function uses the following db keys on the symbol:

HoldUpdate

hold.release

(

var

symname

)

Release the currently held update.

Parameters

symname

- Name of the symbol

Returns

Nothing

This function uses the following db keys on the symbol:

HoldUpdate

hold.update	(	var	symname,
		var	update
	)

Update the held packet with the most recent values.

Parameters

symname	- Symbol name
update	- The new update packet

Returns

Nothing

This function uses the following db keys on the symbol:

HoldUpdate