Packageimpression.resolver
Classpublic class ResolverInfo
InheritanceResolverInfo Inheritance flash.events.EventDispatcher

The ResolverInfo class provides aggregate status information and events for multiple requests.

If the owner property is non-null, the data provided by this instance is for all requests processed through the instance of the AssetResolver object identified by the resolver property that specify the owner property value as the owner of the request.

If the owner property is null, the data provided by this instance is for all requests processed through the instance of the AssetResolver object identified by the resolver property, regardless of the request's owner.

A ResolverInfo object should never be created using the new constructor, it should only be accessed from an AssetResolver via the getOwnerInfo() or registerOwner() methods.



Public Properties
 PropertyDefined By
  bytesLoaded : Number
[read-only] The total number of bytes loaded by all items.
ResolverInfo
  bytesTotal : Number
[read-only] The total number of bytes in all files loaded by all items.
ResolverInfo
  itemsActive : Number
[read-only] The number of items currently loading data.
ResolverInfo
  itemsTotal : Number
[read-only] The total number of active and inactive items.
ResolverInfo
  kbpsAverage : Number
[read-only] The average of the kbps property values for all items.
ResolverInfo
  kbpsTotal : Number
[read-only] The sum of the kbps property values for all items.
ResolverInfo
  latencyAverage : Number
[read-only] The average of the latency property values for all items.
ResolverInfo
  latencyTotal : Number
[read-only] The sum of the latency property values for all items.
ResolverInfo
  owner : *
[read-only] The scope object associated with this instance.
ResolverInfo
  resolver : AssetResolver
[read-only] The AssetResolver object associated with this instance.
ResolverInfo
  transactionActive : Boolean
[read-only] true if the owner or the AssetResolver is in transaction mode.
ResolverInfo
  transactionCancelled : Boolean
[read-only] true if transaction mode for the owner or the AssetResolver was cancelled.
ResolverInfo
  transactionEnded : Boolean
[read-only] true if the owner or the AssetResolver was placed in transaction mode, and is no longer in transaction mode.
ResolverInfo
  transactionStarted : Boolean
[read-only] true if the owner or the AssetResolver is in transaction mode, and at least one item in the scope of the ResolverInfo object has begun loading.
ResolverInfo
Public Methods
 MethodDefined By
  
clear():void
Resets the aggregate statistics.
ResolverInfo
Events
 Event Summary Defined By
  Dispatched when an item within the scope of the ResolverInfo object receives a request to begin loading data.ResolverInfo
  Dispatched when the first item since the owner or AssetResolver was placed into transaction mode begins loading data.ResolverInfo
  Dispatched when an item within the scope of the ResolverInfo object has finished loading data.ResolverInfo
  Dispatched when the last active item since the owner's or AssetResolver's transaction mode was ended has finished loading data.ResolverInfo
  Dispatched when data is received as a download operation progresses for any item within the scope of the ResolverInfo object.ResolverInfo
Property Detail
bytesLoadedproperty
bytesLoaded:Number  [read-only]

The total number of bytes loaded by all items.


Implementation
    public function get bytesLoaded():Number

See also

bytesTotalproperty 
bytesTotal:Number  [read-only]

The total number of bytes in all files loaded by all items.


Implementation
    public function get bytesTotal():Number

See also

itemsActiveproperty 
itemsActive:Number  [read-only]

The number of items currently loading data.


Implementation
    public function get itemsActive():Number
itemsTotalproperty 
itemsTotal:Number  [read-only]

The total number of active and inactive items.


Implementation
    public function get itemsTotal():Number

See also

kbpsAverageproperty 
kbpsAverage:Number  [read-only]

The average of the kbps property values for all items.


Implementation
    public function get kbpsAverage():Number

See also

kbpsTotalproperty 
kbpsTotal:Number  [read-only]

The sum of the kbps property values for all items.


Implementation
    public function get kbpsTotal():Number

See also

latencyAverageproperty 
latencyAverage:Number  [read-only]

The average of the latency property values for all items.


Implementation
    public function get latencyAverage():Number

See also

latencyTotalproperty 
latencyTotal:Number  [read-only]

The sum of the latency property values for all items.


Implementation
    public function get latencyTotal():Number

See also

ownerproperty 
owner:*  [read-only]

The scope object associated with this instance.

If this property value is null, information and events available from this object are applicable to all objects that use the resolver referenced by the resolver property. If this property value is non-null, information and events available from this object are applicable only to those objects whose owner property value matches this value.


Implementation
    public function get owner():*
resolverproperty 
resolver:AssetResolver  [read-only]

The AssetResolver object associated with this instance.


Implementation
    public function get resolver():AssetResolver
transactionActiveproperty 
transactionActive:Boolean  [read-only]

true if the owner or the AssetResolver is in transaction mode.

An item is in transaction mode if the beginOwnerTransaction() method (for an owner) or the beginTransaction() method (for an AssetResolver) has been invoked, and the endOwnerTransaction(), the endTransaction, cancelOwnerTransaction(), the cancelTransaction methods, as appropriate, have not been invoked since the begin method was invoked.

Note that placing an owner or resolver into transaction mode does not cause the ResolverEvent.BEGIN_TRANSACTION event to be dispatched. This event will be dispatched when an item in the scope of the ResolverInfo object begins loading.


Implementation
    public function get transactionActive():Boolean

See also

transactionCancelledproperty 
transactionCancelled:Boolean  [read-only]

true if transaction mode for the owner or the AssetResolver was cancelled.

Transaction mode is canclled by invoking the cancelOwnerTransaction() or the cancelTransaction(), as appropriate.


Implementation
    public function get transactionCancelled():Boolean

See also

transactionEndedproperty 
transactionEnded:Boolean  [read-only]

true if the owner or the AssetResolver was placed in transaction mode, and is no longer in transaction mode.

Transaction mode may have ended by invoking the endOwnerTransaction(), endTransaction(), cancelOwnerTransaction(), or the cancelTransaction() methods, as appropriate. Depending on the method used to end transaction mode, the ResolverEvent.END_TRANSACTION event may be dispatched when this property value is changed to true.


Implementation
    public function get transactionEnded():Boolean

See also

transactionStartedproperty 
transactionStarted:Boolean  [read-only]

true if the owner or the AssetResolver is in transaction mode, and at least one item in the scope of the ResolverInfo object has begun loading.

The ResolverEvent.BEGIN_TRANSACTION event will be dispatched when this property value is changed to true.


Implementation
    public function get transactionStarted():Boolean

See also

Method Detail
clear()method
public function clear():void

Resets the aggregate statistics.

This method resets both the active and inactive statistics. Note that if items are still active, the active statistics will be updated when the next lifecycle event for an active object occurs.

Event Detail
begin Event
Event Object Type: impression.events.ResolverEvent
ResolverEvent.type property = impression.events.ResolverEvent.BEGIN

Dispatched when an item within the scope of the ResolverInfo object receives a request to begin loading data. This event is dispatched after them item dispatches a ResolverEvent.BEGIN event.

The ResolverEvent.BEGIN constant defines the value of the type property of a begin event object. This event has the following properties:
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
relatedObjectThe object associated with the event. If target is a LoaderEx, SoundEx, or URLLoaderEx object, relatedObject is the instance of the URLRequest object to load. If target is a LoaderInfo object, relatedObject is the content object that originally dispatched the ResolverEvent.BEGIN event.

See also

beginTransaction Event  
Event Object Type: impression.events.ResolverEvent
ResolverEvent.type property = impression.events.ResolverEvent.BEGIN_TRANSACTION

Dispatched when the first item since the owner or AssetResolver was placed into transaction mode begins loading data.

Note that this event occurs before the ResolverInfo dispatches the ResolverEvent.BEGIN method. If both the AssetResolver and a specific owner have been placed into transaction mode, when an item in scope begins loading, the following events are dispatched, in order:

  1. The ResolverInfo object for the AssetResolver dispatches the ResolverEvent.BEGIN_TRANSACTION event.
  2. The ResolverInfo object for the owner dispatches the ResolverEvent.BEGIN_TRANSACTION event.
  3. The ResolverInfo object for the AssetResolver dispatches the ResolverEvent.BEGIN event.
  4. The ResolverInfo object for the owner dispatches the ResolverEvent.BEGIN event.

The ResolverEvent.BEGIN_TRANSACTION constant defines the value of the type property of a begin transaction event object. This event has the following properties:
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
relatedObjectThe object associated with the event. For a ResolverEvent.BEGIN_TRANSACTION event, this value is always null.

See also

end Event  
Event Object Type: impression.events.ResolverEvent
ResolverEvent.type property = impression.events.ResolverEvent.END

Dispatched when an item within the scope of the ResolverInfo object has finished loading data. This event is dispatched after the item dispatches a ResolverEvent.BEGIN event.

The ResolverEvent.END constant defines the value of the type property of an end event object. This event has the following properties:
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
relatedObjectThe object associated with the event. If target is a LoaderEx, SoundEx, or URLLoaderEx object, relatedObject is the instance of the URLRequest object to load. If target is a LoaderInfo object, relatedObject is the content object that originally dispatched the ResolverEvent.BEGIN event.

See also

endTransaction Event  
Event Object Type: impression.events.ResolverEvent
ResolverEvent.type property = impression.events.ResolverEvent.END_TRANSACTION

Dispatched when the last active item since the owner's or AssetResolver's transaction mode was ended has finished loading data. This event is dispathced after the item dispatches a ResolverEvent.END event.

Note that this event occurs after the ResolverInfo dispatches the ResolverEvent.END method. If both the AssetResolver and a specific owner were in transaction mode, when an item in scope finishes loading, the following events are dispatched, in order:

  1. The ResolverInfo object for the owner dispatches the ResolverEvent.END event.
  2. The ResolverInfo object for the owner dispatches the ResolverEvent.END_TRANSACTION event.
  3. The ResolverInfo object for the AssetResolver dispatches the ResolverEvent.END event.
  4. The ResolverInfo object for the AssetResolver dispatches the ResolverEvent.END_TRANSACTION event.

The ResolverEvent.END_TRANSACTION constant defines the value of the type property of an end transaction event object. This event has the following properties:
PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
relatedObjectThe object associated with the event. For a ResolverEvent.END_TRANSACTION event, this value is always null.

See also

progress Event  
Event Object Type: flash.events.ProgressEvent
ProgressEvent.type property = flash.events.ProgressEvent.PROGRESS

Dispatched when data is received as a download operation progresses for any item within the scope of the ResolverInfo object.

Note that when the ResolverInfo object dispatches this event, the bytesLoaded and bytesTotal property values of the event correspond to the ResolverInfo object's bytesLoaded and bytesTotal property values, not the values of the item that originally reported progress.