Packagenet.user1.reactor.snapshot
Classpublic class NodeListSnapshot
InheritanceNodeListSnapshot Inheritance Snapshot Inheritance flash.events.EventDispatcher

Since : Reactor 2.0.0

The NodeListSnapshot class is used to load a list of the Union Server nodes connected to the current server. By default, access to the current server's node list requires administrator privileges.
   // Create a snapshot of node IDs 
   var snapshot:NodeListSnapshot = new NodeListSnapshot();
   
   // Register a callback function
   snapshot.onLoad = function ():void { 
     trace("Here is the node list: " + snapshot.getNodeList());
   }
   
   // Or register a listener function
   snapshot.addEventListener(SnapshotEvent.LOAD, loadListener);
   function loadListener (e:SnapshotEvent):void {
     var snapshot:NodeListSnapshot = NodeListSnapshot(e.target);
     trace("Here is the node list: " + snapshot.getNodeList());
   }
   
   // Load the node list by passing the snapshot object to 
   // Reactor's updateSnapshot() method:
   reactor.updateSnapshot(snapshot);
   

The list of node IDs retrieved by NodeListSnapshot is a one-time snapshot of the state of the server, and is not kept up to date after it is loaded. To update a NodeListSnapshot object to match latest the state of the server, pass that object to Reactor's updateSnapshot() method.

See also

SnapshotEvent
Snapshot
net.user1.reactor.Reactor.updateSnapshot()


Public Variables
 VariableDefined By
 InheritedonLoad : Function
A callback function to be invoked when this snapshot's data is loaded.
Snapshot
Public Methods
 MethodDefined By
  
Constructor
NodeListSnapshot
  
getNodeList():Array
Returns an array of the node IDs for the Union Server nodes connected to the current server.
NodeListSnapshot
 Inherited
getStatus():String
Returns the status of the most recent snapshot load-operation.
Snapshot
 Inherited
Indicates whether the snapshot is currently loading data.
Snapshot
Events
 Event Summary Defined By
 Inherited Dispatched when a snapshot object has been updated in response to an earlier call to Reactor's updateSnapshot() method.Snapshot
 Inherited Dispatched when the result of an update request has been received by a snapshot object.Snapshot
Constructor Description
NodeListSnapshot()Constructor
public function NodeListSnapshot()

Constructor

Method Descriptions
getNodeList()method
public function getNodeList():Array

Since : Reactor 2.0.0

Returns an array of the node IDs for the Union Server nodes connected to the current server.

Returns
Array