Package | net.user1.reactor.snapshot |
Class | public class ServerModuleListSnapshot |
Inheritance | ServerModuleListSnapshot ![]() ![]() |
Since : | Reactor 1.0.2 |
// Create the snapshot var snapshot:ServerModuleListSnapshot = new ServerModuleListSnapshot(); // Register a callback function snapshot.onLoad = function ():void { trace("Here is the server-module list: " + snapshot.getModuleList()); } // Or register a listener function snapshot.addEventListener(SnapshotEvent.LOAD, loadListener); function loadListener (e:SnapshotEvent):void { var snapshot:ServerModuleListSnapshot = ServerModuleListSnapshot(e.target); trace("Here is the server-module list: " + snapshot.getModuleList()); } // Load the module list by passing the snapshot object to // Reactor's updateSnapshot() method: reactor.updateSnapshot(snapshot);
The list of modules retrieved by ServerModuleListSnapshot 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 ServerModuleListSnapshot object to match latest the state of the server, pass that object to Reactor's updateSnapshot() method.
See also
Method | Defined By | ||
---|---|---|---|
Constructor
| ServerModuleListSnapshot | ||
getModuleList():Array
Returns an array of the server modules active on the server. | ServerModuleListSnapshot | ||
![]() | getStatus():String
Returns the status of the most recent snapshot load-operation. | Snapshot | |
![]() | updateInProgress():Boolean
Indicates whether the snapshot is currently loading data. | Snapshot |
ServerModuleListSnapshot | () | Constructor |
public function ServerModuleListSnapshot()
Constructor
getModuleList | () | method |
public function getModuleList():Array
Since : | Reactor 1.0.2 |
Returns an array of the server modules active on the server.
ReturnsArray |