Handle halt status

Detailed Description

This package supports the concept of a simple latch for halting updates to a symbol. It is up to the caller to stop processing the update should halt.ishalted() return 1

Functions
	halt.ishalted (var symname)
	Check whether a symbol is halted or not. More...
	halt.halt (var symname)
	Set a symbol to be halted. More...
	halt.resume (var symname)
	Remove the halted state of a symbol. More...

Function Documentation

halt.halt

(

var

symname

)

Set a symbol to be halted.

Parameters

symname

- Symbolname to set halted status of

Returns

Nothing

This function uses the following db keys on the symbol:

IsHalted

halt.ishalted

(

var

symname

)

Check whether a symbol is halted or not.

Parameters

symname

- Symbolname to check

Return values

0	- Symbol isn't halted
1	- Symbol is halted

This function uses the following db keys on the symbol:

IsHalted

halt.resume

(

var

symname

)

Remove the halted state of a symbol.

Parameters

symname

- Symbolname to clear halted status of

Returns

Nothing

This function uses the following db keys on the symbol:

IsHalted