PageRenderTime 41ms CodeModel.GetById 1ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/org/tractionas3/load/BytesTotalPrefetcher.html

http://tractionas3.googlecode.com/
HTML | 316 lines | 297 code | 10 blank | 9 comment | 0 complexity | 5a97b821aa3d98a14073ec1eac12283e MD5 | raw file
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    5. 

  5. <link rel="stylesheet" href="../../../style.css" type="text/css" media="screen">
    6. 

  6. <link rel="stylesheet" href="../../../print.css" type="text/css" media="print">
    7. 

  7. <meta content="BytesTotalPrefetcher,org.tractionas3.load.BytesTotalPrefetcher,prefetchComplete,cancel,destruct,getByteWaste,getPrefetchedBytesTotal" name="keywords">
    8. 

  8. <title>org.tractionas3.load.BytesTotalPrefetcher</title>
    9. 

  9. </head>
    10. 

  10. <body>
    11. 

  11. <script type="text/javascript" language="javascript" src="../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../cookies.js"></script><script type="text/javascript" language="javascript">
    12. 

  12. <!--
    13. 

  13. 				asdocTitle = 'BytesTotalPrefetcher - TractionAS3 Framework Documentation';
    14. 

  14. 				var baseRef = '../../../';
    15. 

  15. 				window.onload = configPage;
    16. 

  16. 			--></script>
    17. 

  17. <table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
    18. 

  18. <tr>
    19. 

  19. <td align="left" class="titleTableTitle">TractionAS3 Framework Documentation</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../all-classes.html')" href="../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../index-list.html')" href="../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../index.html?org/tractionas3/load/BytesTotalPrefetcher.html&amp;org/tractionas3/load/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../images/logo.jpg"></td>
    20. 

  20. </tr>
    21. 

  21. <tr class="titleTableRow2">
    22. 

  22. <td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;BytesTotalPrefetcher</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
    23. 

  23. </tr>
    24. 

  24. <tr class="titleTableRow3">
    25. 

  25. <td colspan="2">&nbsp;</td>
    26. 

  26. </tr>
    27. 

  27. </table>
    28. 

  28. <script type="text/javascript" language="javascript">
    29. 

  29. <!--
    30. 

  30. if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class BytesTotalPrefetcher"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
    31. 

  31. --></script>
    32. 

  32. <div class="MainContent">
    33. 

  33. <table cellspacing="0" cellpadding="0" class="classHeaderTable">
    34. 

  34. <tr>
    35. 

  35. <td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.tractionas3.load</a></td>
    36. 

  36. </tr>
    37. 

  37. <tr>
    38. 

  38. <td class="classHeaderTableLabel">Class</td><td class="classSignature">public class BytesTotalPrefetcher</td>
    39. 

  39. </tr>
    40. 

  40. <tr>
    41. 

  41. <td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">BytesTotalPrefetcher <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> <a href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> <a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../images/inherit-arrow.gif"> flash.events.EventDispatcher</td>
    42. 

  42. </tr>
    43. 

  43. <tr>
    44. 

  44. <td class="classHeaderTableLabel">Implements</td><td><a href="../core/interfaces/ICancelable.html">ICancelable</a>, <a href="../core/interfaces/ICoreInterface.html">ICoreInterface</a></td>
    45. 

  45. </tr>
    46. 

  46. </table>
    47. 

  47. <p></p>
    48. 

  48.   BytesTotalPrefetcher is a class used to determine a files size before loading it.
    49. 

  49.   
    50. 

  50.   <p>
    51. 

  51.   Prefetching file size involves a second load process, which is immeadiately cancelled as soon as the file
    52. 

  52.   size is detected. Any loaded data (and reference to it) is discarded. The amount of time a prefetch takes is not determined by the connection speed, but rather
    53. 

  53.   the latency.
    54. 

  54.   </p>
    55. 

  55.   
    56. 

  56.   <p></p>
    57. 

  57. <p>
    58. 

  58. <span class="classHeaderTableLabel">See also</span>
    59. 

  59. </p>
    60. 

  60. <div class="seeAlso">
    61. 

  61. <a href="../load/BytesTotalPrefetcher.html#byteWaste" target="">byteWaste</a>
    62. 

  62. </div>
    63. 

  63. <br>
    64. 

  64. <hr>
    65. 

  65. </div>
    66. 

  66. <a name="propertySummary"></a>
    67. 

  67. <div class="summarySection">
    68. 

  68. <div class="summaryTableTitle">Public Properties</div>
    69. 

  69. <table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
    70. 

  70. <tr>
    71. 

  71. <th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
    72. 

  72. </tr>
    73. 

  73. <tr class="">
    74. 

  74. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#prefetchComplete">prefetchComplete</a> : Boolean<div class="summaryTableDescription">[read-only]
    75. 

  75.    Indicates whether the prefetch is complete.</div>
    76. 

  76. </td><td class="summaryTableOwnerCol">BytesTotalPrefetcher</td>
    77. 

  77. </tr>
    78. 

  78. </table>
    79. 

  79. </div>
    80. 

  80. <a name="methodSummary"></a>
    81. 

  81. <div class="summarySection">
    82. 

  82. <div class="summaryTableTitle">Public Methods</div>
    83. 

  83. <div class="showHideLinks">
    84. 

  84. <div class="hideInheritedMethod" id="hideInheritedMethod">
    85. 

  85. <a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
    86. 

  86. </div>
    87. 

  87. <div class="showInheritedMethod" id="showInheritedMethod">
    88. 

  88. <a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
    89. 

  89. </div>
    90. 

  90. </div>
    91. 

  91. <table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
    92. 

  92. <tr>
    93. 

  93. <th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
    94. 

  94. </tr>
    95. 

  95. <tr class="">
    96. 

  96. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    97. 

  97. <div class="summarySignature">
    98. 

  98. <a class="signatureLink" href="#BytesTotalPrefetcher()">BytesTotalPrefetcher</a>(request:URLRequest)</div>
    99. 

  99. <div class="summaryTableDescription">
    100. 

  100.    BytesTotalPrefetcher Constructor
    101. 

  101.    
    102. 

  102.    </div>
    103. 

  103. </td><td class="summaryTableOwnerCol">BytesTotalPrefetcher</td>
    104. 

  104. </tr>
    105. 

  105. <tr class="hideInheritedMethod">
    106. 

  106. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    107. 

  107. <div class="summarySignature">
    108. 

  108. <a class="signatureLink" href="../events/WeakEventDispatcher.html#addEventListener()">addEventListener</a>(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void</div>
    109. 

  109. <div class="summaryTableDescription">
    110. 

  110.    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.</div>
    111. 

  111. </td><td class="summaryTableOwnerCol"><a href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a></td>
    112. 

  112. </tr>
    113. 

  113. <tr class="">
    114. 

  114. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    115. 

  115. <div class="summarySignature">
    116. 

  116. <a class="signatureLink" href="#cancel()">cancel</a>():void</div>
    117. 

  117. <div class="summaryTableDescription">
    118. 

  118.    Cancels the prefetch.</div>
    119. 

  119. </td><td class="summaryTableOwnerCol">BytesTotalPrefetcher</td>
    120. 

  120. </tr>
    121. 

  121. <tr class="">
    122. 

  122. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    123. 

  123. <div class="summarySignature">
    124. 

  124. <a class="signatureLink" href="#destruct()">destruct</a>(deepDestruct:Boolean = false):void</div>
    125. 

  125. <div class="summaryTableDescription">
    126. 

  126.    
    127. 

  127.    Destructs implementing instance of specified properties.</div>
    128. 

  128. </td><td class="summaryTableOwnerCol">BytesTotalPrefetcher</td>
    129. 

  129. </tr>
    130. 

  130. <tr class="hideInheritedMethod">
    131. 

  131. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    132. 

  132. <div class="summarySignature">
    133. 

  133. <a class="signatureLink" href="../events/WeakEventDispatcher.html#dispatchEvent()">dispatchEvent</a>(e:Event):Boolean</div>
    134. 

  134. <div class="summaryTableDescription">
    135. 

  135.    Dispatches an event into the event flow, <i>only</i> if event property <code>hasEventListener</code> or <code>bubbles</code> are <code>true</code>.</div>
    136. 

  136. </td><td class="summaryTableOwnerCol"><a href="../events/WeakEventDispatcher.html">WeakEventDispatcher</a></td>
    137. 

  137. </tr>
    138. 

  138. <tr class="">
    139. 

  139. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    140. 

  140. <div class="summarySignature">
    141. 

  141. <a class="signatureLink" href="#getByteWaste()">getByteWaste</a>():uint</div>
    142. 

  142. <div class="summaryTableDescription">
    143. 

  143.    Returns the number of excess loaded bytes caused by the prefetch.</div>
    144. 

  144. </td><td class="summaryTableOwnerCol">BytesTotalPrefetcher</td>
    145. 

  145. </tr>
    146. 

  146. <tr class="">
    147. 

  147. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
    148. 

  148. <div class="summarySignature">
    149. 

  149. <a class="signatureLink" href="#getPrefetchedBytesTotal()">getPrefetchedBytesTotal</a>():uint</div>
    150. 

  150. <div class="summaryTableDescription">
    151. 

  151.    Returns the prefetched file size of target file.</div>
    152. 

  152. </td><td class="summaryTableOwnerCol">BytesTotalPrefetcher</td>
    153. 

  153. </tr>
    154. 

  154. <tr class="hideInheritedMethod">
    155. 

  155. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    156. 

  156. <div class="summarySignature">
    157. 

  157. <a class="signatureLink" href="../events/ClearableEventDispatcher.html#listDestructableProperties()">listDestructableProperties</a>():Array</div>
    158. 

  158. <div class="summaryTableDescription">
    159. 

  159.    
    160. 

  160.    Specifies an array of strings representing properties that are to be
    161. 

  161.    nullified or reset upon destruction.</div>
    162. 

  162. </td><td class="summaryTableOwnerCol"><a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    163. 

  163. </tr>
    164. 

  164. <tr class="hideInheritedMethod">
    165. 

  165. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    166. 

  166. <div class="summarySignature">
    167. 

  167. <a class="signatureLink" href="../events/ClearableEventDispatcher.html#removeAllEventListeners()">removeAllEventListeners</a>():void</div>
    168. 

  168. <div class="summaryTableDescription">
    169. 

  169.    
    170. 

  170.    Removes all event listeners from the IClearableEventDispatcher object.</div>
    171. 

  171. </td><td class="summaryTableOwnerCol"><a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    172. 

  172. </tr>
    173. 

  173. <tr class="hideInheritedMethod">
    174. 

  174. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    175. 

  175. <div class="summarySignature">
    176. 

  176. <a class="signatureLink" href="../events/ClearableEventDispatcher.html#removeEventListener()">removeEventListener</a>(type:String, listener:Function, useCapture:Boolean = false):void</div>
    177. 

  177. <div class="summaryTableDescription">
    178. 

  178.    Removes a listener from the EventDispatcher object.</div>
    179. 

  179. </td><td class="summaryTableOwnerCol"><a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    180. 

  180. </tr>
    181. 

  181. <tr class="hideInheritedMethod">
    182. 

  182. <td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
    183. 

  183. <div class="summarySignature">
    184. 

  184. <a class="signatureLink" href="../events/ClearableEventDispatcher.html#toString()">toString</a>():String</div>
    185. 

  185. <div class="summaryTableDescription">
    186. 

  186.    Returns the string representation of the specified object.</div>
    187. 

  187. </td><td class="summaryTableOwnerCol"><a href="../events/ClearableEventDispatcher.html">ClearableEventDispatcher</a></td>
    188. 

  188. </tr>
    189. 

  189. </table>
    190. 

  190. </div>
    191. 

  191. <script type="text/javascript" language="javascript">
    192. 

  192. <!--
    193. 

  193. showHideInherited();
    194. 

  194. --></script>
    195. 

  195. <div class="MainContent">
    196. 

  196. <a name="propertyDetail"></a>
    197. 

  197. <div class="detailSectionHeader">Property detail</div>
    198. 

  198. <a name="prefetchComplete"></a>
    199. 

  199. <table cellspacing="0" cellpadding="0" class="detailHeader">
    200. 

  200. <tr>
    201. 

  201. <td class="detailHeaderName">prefetchComplete</td><td class="detailHeaderType">property</td>
    202. 

  202. </tr>
    203. 

  203. </table>
    204. 

  204. <div class="detailBody">
    205. 

  205. <code>prefetchComplete:Boolean</code>&nbsp;&nbsp;[read-only]<p>
    206. 

  206.    Indicates whether the prefetch is complete.
    207. 

  207.    </p><span class="label">Implementation</span>
    208. 

  208. <br>
    209. 

  209. <code>&nbsp;&nbsp;&nbsp;&nbsp;public function get prefetchComplete():Boolean</code>
    210. 

  210. <br>
    211. 

  211. </div>
    212. 

  212. <a name="constructorDetail"></a>
    213. 

  213. <div class="detailSectionHeader">Constructor detail</div>
    214. 

  214. <a name="BytesTotalPrefetcher()"></a>
    215. 

  215. <table cellspacing="0" cellpadding="0" class="detailHeader">
    216. 

  216. <tr>
    217. 

  217. <td class="detailHeaderName">BytesTotalPrefetcher</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
    218. 

  218. </tr>
    219. 

  219. </table>
    220. 

  220. <div class="detailBody">
    221. 

  221. <code>public function BytesTotalPrefetcher(request:URLRequest)</code><p>
    222. 

  222.    BytesTotalPrefetcher Constructor
    223. 

  223.    
    224. 

  224.    </p><span class="label">Parameters</span>
    225. 

  225. <table border="0" cellspacing="0" cellpadding="0">
    226. 

  226. <tr>
    227. 

  227. <td width="20px"></td><td><code><span class="label">request</span>:URLRequest</code> &mdash; URLRequest defining the URL of the file to load.
    228. 

  228.    </td>
    229. 

  229. </tr>
    230. 

  230. </table>
    231. 

  231. </div>
    232. 

  232. <a name="methodDetail"></a>
    233. 

  233. <div class="detailSectionHeader">Method detail</div>
    234. 

  234. <a name="cancel()"></a>
    235. 

  235. <table cellspacing="0" cellpadding="0" class="detailHeader">
    236. 

  236. <tr>
    237. 

  237. <td class="detailHeaderName">cancel</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
    238. 

  238. </tr>
    239. 

  239. </table>
    240. 

  240. <div class="detailBody">
    241. 

  241. <code>public function cancel():void</code><p>
    242. 

  242.    Cancels the prefetch.
    243. 

  243.    </p></div>
    244. 

  244. <a name="destruct()"></a>
    245. 

  245. <table cellspacing="0" cellpadding="0" class="detailHeader">
    246. 

  246. <tr>
    247. 

  247. <td class="detailHeaderName">destruct</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    248. 

  248. </tr>
    249. 

  249. </table>
    250. 

  250. <div class="detailBody">
    251. 

  251. <code>public override function destruct(deepDestruct:Boolean = false):void</code><p>
    252. 

  252.    
    253. 

  253.    Destructs implementing instance of specified properties.
    254. 

  254.    <p />
    255. 

  255.    <b>Note:</b> You can override this method to remove unused references in your custom class.
    256. 

  256.    
    257. 

  257.    </p><span class="label">Parameters</span>
    258. 

  258. <table border="0" cellspacing="0" cellpadding="0">
    259. 

  259. <tr>
    260. 

  260. <td width="20px"></td><td><code><span class="label">deepDestruct</span>:Boolean</code> (default = <code>false</code>)<code></code></td>
    261. 

  261. </tr>
    262. 

  262. </table>
    263. 

  263. </div>
    264. 

  264. <a name="getByteWaste()"></a>
    265. 

  265. <table cellspacing="0" cellpadding="0" class="detailHeader">
    266. 

  266. <tr>
    267. 

  267. <td class="detailHeaderName">getByteWaste</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    268. 

  268. </tr>
    269. 

  269. </table>
    270. 

  270. <div class="detailBody">
    271. 

  271. <code>public function getByteWaste():uint</code><p>
    272. 

  272.    Returns the number of excess loaded bytes caused by the prefetch.
    273. 

  273.    </p><p>
    274. 

  274.    Note that the file size is fetched as soon as any load progress is detected, no matter how small.
    275. 

  275.    This means that the amount of excess loaded bytes is in direct proportion to the connection speed
    276. 

  276.    between client and server. A slower connection will load less excess amount of data than a fast connection.
    277. 

  277.    </p>
    278. 

  278.    <p></p>
    279. 

  279. <span class="label">Returns</span>
    280. 

  280. <table border="0" cellspacing="0" cellpadding="0">
    281. 

  281. <tr>
    282. 

  282. <td width="20"></td><td><code>uint</code> &mdash; Excess loaded amount of data in bytes.
    283. 

  283.    </td>
    284. 

  284. </tr>
    285. 

  285. </table>
    286. 

  286. </div>
    287. 

  287. <a name="getPrefetchedBytesTotal()"></a>
    288. 

  288. <table cellspacing="0" cellpadding="0" class="detailHeader">
    289. 

  289. <tr>
    290. 

  290. <td class="detailHeaderName">getPrefetchedBytesTotal</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
    291. 

  291. </tr>
    292. 

  292. </table>
    293. 

  293. <div class="detailBody">
    294. 

  294. <code>public function getPrefetchedBytesTotal():uint</code><p>
    295. 

  295.    Returns the prefetched file size of target file. 
    296. 

  296.    
    297. 

  297.    </p><p></p>
    298. 

  298. <span class="label">Returns</span>
    299. 

  299. <table border="0" cellspacing="0" cellpadding="0">
    300. 

  300. <tr>
    301. 

  301. <td width="20"></td><td><code>uint</code> &mdash; File size in bytes.
    302. 

  302.    </td>
    303. 

  303. </tr>
    304. 

  304. </table>
    305. 

  305. </div>
    306. 

  306. <br>
    307. 

  307. <br>
    308. 

  308. <hr>
    309. 

  309. <br>
    310. 

  310. <p></p>
    311. 

  311. <center class="copyright"> 
    312. 

  312. </center>
    313. 

  313. </div>
    314. 

  314. </body>
    315. 

  315. </html>
    316. 

  316. <!-- -->
    317. 

  317.