Cluster control

Detailed Description

The cluster API gives programmatic access to the cluster channel that may be configured between two instances of a Transformer.

Functions
	cluster.isPrimary ()
	Query whether this node is primary. More...
	cluster.sendUpdate (var update)
	Send an update to all members of the cluster. More...
	cluster.sendUpdateToNode (var node, var update)
	Send an update to a particular node in the cluster. More...
	cluster.sendNodata (var name)
	Send an nodata message to all members of the cluster. More...
	cluster.sendNodataToNode (var node, var name, var flags)
	Send an nodata message to a particular node in the cluster. More...
	cluster.resetUpTime ()
	Reset the uptime for this node. More...
	cluster.isNodeUp (var node)
	Query whether a node in a cluster is available. More...
	cluster.getNodeIndex ()
	Return this system's node index within the cluster. More...
	cluster.shouldProcess (var symbolname)
	Check if this node should process a packet. More...
	cluster.getClusterSize ()
	Get the number of nodes in the cluster. More...

Function Documentation

cluster.getClusterSize

(

)

Get the number of nodes in the cluster.

Returns

The number of nodes in the cluster.

cluster.getNodeIndex

(

)

Return this system's node index within the cluster.

Returns

The node index

cluster.isNodeUp

(

var

node

)

Query whether a node in a cluster is available.

Parameters

node	- Node to query

Return values

0	- This node isn't available
1	- This node is available

cluster.isPrimary

(

)

Query whether this node is primary.

Return values

0	- This node isn't primary
1	- This node is primary
nil	- if the fieldname is not known

cluster.resetUpTime

(

)

Reset the uptime for this node.

This may result in this node no longer being primary

cluster.sendNodata

(

var

name

)

Send an nodata message to all members of the cluster.

Parameters

name	- Name of the symbol

cluster.sendNodataToNode	(	var	node,
		var	name,
		var	flags
	)

Send an nodata message to a particular node in the cluster.

Parameters

node	- Node to send the message to
name	- Name of the symbol
flags	- Nodata flags

cluster.sendUpdate

(

var

update

)

Send an update to all members of the cluster.

Parameters

update

- Update to distribute

cluster.sendUpdateToNode	(	var	node,
		var	update
	)

Send an update to a particular node in the cluster.

Parameters

node	- Node to send the update to
update	- Update to distribute

cluster.shouldProcess

(

var

symbolname

)

Check if this node should process a packet.

Parameters

symbolname

- The packet subject

Return values

0	- This node shouldn't process the packet
1	- This node should process the packet