Packagenet.user1.reactor.snapshot
Classpublic class BannedListSnapshot
InheritanceBannedListSnapshot Inheritance Snapshot Inheritance flash.events.EventDispatcher

Since : Reactor 1.0.0

The BannedListSnapshot class is used to load the server's current list of banned client addresses. The following code demonstrates:
   // Create the snapshot 
   var snapshot:BannedListSnapshot = new BannedListSnapshot();
   
   // Register a callback function
   snapshot.onLoad = function ():void { 
     trace("Here is the banned address list: " + snapshot.getBannedList());
   }
   
   // Or register a listener function
   snapshot.addEventListener(SnapshotEvent.LOAD, loadListener);
   function loadListener (e:SnapshotEvent):void {
     var snapshot:BannedListSnapshot = BannedListSnapshot(e.target);
     trace("Here is the banned address list: " + snapshot.getBannedList());
   }
   
   // Load the banned address list by passing the snapshot object to 
   // Reactor's updateSnapshot() method:
   reactor.updateSnapshot(snapshot);
   

The list of banned addresses retrieved by BannedListSnapshot 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 BannedListSnapshot 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
BannedListSnapshot
  
Returns an array of the banned addresses on the server.
BannedListSnapshot
 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
BannedListSnapshot()Constructor
public function BannedListSnapshot()

Constructor

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

Since : Reactor 1.0.0

Returns an array of the banned addresses on the server.

Returns
Array