PageRenderTime 51ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/php/class.evstat.html

https://bitbucket.org/stillzhl/manuals
HTML | 359 lines | 301 code | 58 blank | 0 comment | 0 complexity | 6d923eaac31debb7720862ba6aa249c1 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.   <title>The EvStat class</title>
    6. 

  6. 

  7.  </head>
    8. 

  8.  <body><div class="manualnavbar" style="text-align: center;">
    9. 

  9.  <div class="prev" style="text-align: left; float: left;"><a href="evsignal.set.html">EvSignal::set</a></div>
    10. 

  10.  <div class="next" style="text-align: right; float: right;"><a href="evstat.attr.html">EvStat::attr</a></div>
    11. 

  11.  <div class="up"><a href="book.ev.html">Ev</a></div>
    12. 

  12.  <div class="home"><a href="index.html">PHP Manual</a></div>
    13. 

  13. </div><hr /><div id="class.evstat" class="reference">
    14. 

  14.  <h1 class="title">The EvStat class</h1>
    15. 

  15.  
    16. 

  16.  <div class="partintro"><p class="verinfo">(No version information available, might only be in SVN)</p>
    17. 

  17. 

  18.   <div class="section" id="evstat.intro">
    19. 

  19.    <h2 class="title">简介</h2>
    20. 

  20.    <p class="para">
    21. 

  21.     <strong class="classname">EvStat</strong>
    22. 

  22.     monitors a file system path for attribute changes. It calls
    23. 

  23.     <em class="emphasis">stat()</em>
    24. 

  24.     on that path in regular intervals(or when the OS signals it changed) and
    25. 

  25.     sees if it changed compared to the last time, invoking the callback if it
    26. 

  26.     did.
    27. 

  27.    </p>
    28. 

  28.    <p class="para">
    29. 

  29.     The path does not need to exist: changing from &quot;path exists&quot; to &quot;path does
    30. 

  30.     not exist&quot; is a status change like any other. The condition &quot;path does not
    31. 

  31.     exist&quot; is signified by the
    32. 

  32.     <strong><code>&#039;nlink&#039;</code></strong>
    33. 

  33.     item being 0(returned by
    34. 

  34.      <span class="methodname"><a href="evstat.attr.html" class="methodname">EvStat::attr()</a></span>
    35. 

  35.     method).
    36. 

  36.    </p>
    37. 

  37.    <p class="para">
    38. 

  38.     The path must not end in a slash or contain special components such as
    39. 

  39.     <strong><code>&#039;.&#039;</code></strong>
    40. 

  40.     or
    41. 

  41.     <strong><code>..</code></strong>
    42. 

  42.     . The path should be absolute: if it is relative and the working directory
    43. 

  43.     changes, then the behaviour is undefined.
    44. 

  44.    </p>
    45. 

  45.    <p class="para">
    46. 

  46.     Since there is no portable change notification interface available, the
    47. 

  47.     portable implementation simply calls
    48. 

  48.     <em class="emphasis">stat()</em>
    49. 

  49.     regularly on the path to see if it changed somehow. For this case a
    50. 

  50.     recommended polling interval can be specified. If one specifies a polling
    51. 

  51.     interval of
    52. 

  52.     <strong><code>0.0 </code></strong>
    53. 

  53.     (highly recommended) then a suitable, unspecified default value will be
    54. 

  54.     used(which could be expected to be around 5 seconds, although this might
    55. 

  55.     change dynamically).
    56. 

  56.     <em class="emphasis">libev</em>
    57. 

  57.     will also impose a minimum interval which is currently around
    58. 

  58.     <strong><code>0.1</code></strong>
    59. 

  59.     , but that’s usually overkill.
    60. 

  60.    </p>
    61. 

  61.    <p class="para">
    62. 

  62.     This watcher type is not meant for massive numbers of
    63. 

  63.     <strong class="classname">EvStat</strong>
    64. 

  64.     watchers, as even with OS-supported change notifications, this can be
    65. 

  65.     resource-intensive.
    66. 

  66.    </p>
    67. 

  67.   </div>
    68. 

  68. 

  69.   <div class="section" id="evstat.synopsis">
    70. 

  70.    <h2 class="title">类摘要</h2>
    71. 

  71. 

  72. 

  73.    <div class="classsynopsis">
    74. 

  74.     <div class="ooclass">
    75. 

  75.      
    76. 

  76.     </div>
    77. 

  77. 

  78.     <div class="classsynopsisinfo">
    79. 

  79.      <span class="ooclass">
    80. 

  80.       <strong class="classname">EvStat</strong>
    81. 

  81.      </span>
    82. 

  82.      <span class="ooclass">
    83. 

  83.       <span class="modifier">extends</span>
    84. 

  84.       <a href="class.evwatcher.html" class="classname">EvWatcher</a>
    85. 

  85.      </span>
    86. 

  86.      {</div>
    87. 

  87. 

  88.     <div class="classsynopsisinfo classsynopsisinfo_comment">/* 属性 */</div>
    89. 

  89.     <div class="fieldsynopsis">
    90. 

  90.      <span class="modifier">public</span>
    91. 

  91.       <var class="varname"><a href="class.evstat.html#evstat.props.path">$<var class="varname">path</var></a></var>
    92. 

  92.     ;</div>
    93. 

  93. 

  94.     <div class="fieldsynopsis">
    95. 

  95.      <span class="modifier">public</span>
    96. 

  96.       <var class="varname"><a href="class.evstat.html#evstat.props.interval">$<var class="varname">interval</var></a></var>
    97. 

  97.     ;</div>
    98. 

  98. 

  99.     <div class="classsynopsisinfo classsynopsisinfo_comment">/* 继承的属性 */</div>
    100. 

  100.     <div class="fieldsynopsis">
    101. 

  101.      <span class="modifier">public</span>
    102. 

  102.       <var class="varname"><a href="class.evwatcher.html#evwatcher.props.is-active">$<var class="varname">is_active</var></a></var>
    103. 

  103.     ;</div>
    104. 

  104. <div class="fieldsynopsis">
    105. 

  105.      <span class="modifier">public</span>
    106. 

  106.       <var class="varname"><a href="class.evwatcher.html#evwatcher.props.data">$<var class="varname">data</var></a></var>
    107. 

  107.     ;</div>
    108. 

  108. <div class="fieldsynopsis">
    109. 

  109.      <span class="modifier">public</span>
    110. 

  110.       <var class="varname"><a href="class.evwatcher.html#evwatcher.props.is-pending">$<var class="varname">is_pending</var></a></var>
    111. 

  111.     ;</div>
    112. 

  112. <div class="fieldsynopsis">
    113. 

  113.      <span class="modifier">public</span>
    114. 

  114.       <var class="varname"><a href="class.evwatcher.html#evwatcher.props.priority">$<var class="varname">priority</var></a></var>
    115. 

  115.     ;</div>
    116. 

  116. 

  117.     <div class="classsynopsisinfo classsynopsisinfo_comment">/* 方法 */</div>
    118. 

  118.     <div class="methodsynopsis dc-description">
    119. 

  119.    <span class="modifier">public</span>
    120. 

  120.    <span class="type">array</span>
    121. 

  121.     <span class="methodname"><a href="evstat.attr.html" class="methodname">attr</a></span>
    122. 

  122.     ( <span class="methodparam">void</span>
    123. 

  123.    )</div>
    124. 

  124. <div class="methodsynopsis dc-description">
    125. 

  125.    <span class="modifier">public</span>
    126. 

  126.     <span class="methodname"><a href="evstat.construct.html" class="methodname">__construct</a></span>
    127. 

  127.     ( <span class="methodparam">
    128. 

  128.     <span class="type">string</span>
    129. 

  129.      <code class="parameter">$path</code>
    130. 

  130.    </span>
    131. 

  131.    , <span class="methodparam">
    132. 

  132.     <span class="type">double</span>
    133. 

  133.      <code class="parameter">$interval</code>
    134. 

  134.    </span>
    135. 

  135.    , <span class="methodparam">
    136. 

  136.     <span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span>
    137. 

  137.      <code class="parameter">$callback</code>
    138. 

  138.    </span>
    139. 

  139.    [, <span class="methodparam">
    140. 

  140.     <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
    141. 

  141.      <code class="parameter">$data</code>
    142. 

  142.     <span class="initializer"> = <strong><code>NULL</code></strong></span>
    143. 

  143.    </span>
    144. 

  144.    [, <span class="methodparam">
    145. 

  145.     <span class="type">int</span>
    146. 

  146.      <code class="parameter">$priority</code>
    147. 

  147.     <span class="initializer"> = 0</span>
    148. 

  148.    </span>
    149. 

  149.   ]] )</div>
    150. 

  150. <div class="methodsynopsis dc-description">
    151. 

  151.    <span class="modifier">final</span>
    152. 

  152.    <span class="modifier">public</span>
    153. 

  153.    <span class="modifier">static</span>
    154. 

  154.    <span class="type">void</span>
    155. 

  155.     <span class="methodname"><a href="evstat.createstopped.html" class="methodname">createStopped</a></span>
    156. 

  156.     ( <span class="methodparam">
    157. 

  157.     <span class="type">string</span>
    158. 

  158.      <code class="parameter">$path</code>
    159. 

  159.    </span>
    160. 

  160.    , <span class="methodparam">
    161. 

  161.     <span class="type">double</span>
    162. 

  162.      <code class="parameter">$interval</code>
    163. 

  163.    </span>
    164. 

  164.    , <span class="methodparam">
    165. 

  165.     <span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span>
    166. 

  166.      <code class="parameter">$callback</code>
    167. 

  167.    </span>
    168. 

  168.    [, <span class="methodparam">
    169. 

  169.     <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span>
    170. 

  170.      <code class="parameter">$data</code>
    171. 

  171.     <span class="initializer"> = <strong><code>NULL</code></strong></span>
    172. 

  172.    </span>
    173. 

  173.    [, <span class="methodparam">
    174. 

  174.     <span class="type">int</span>
    175. 

  175.      <code class="parameter">$priority</code>
    176. 

  176.     <span class="initializer"> = 0</span>
    177. 

  177.    </span>
    178. 

  178.   ]] )</div>
    179. 

  179. <div class="methodsynopsis dc-description">
    180. 

  180.    <span class="modifier">public</span>
    181. 

  181.    <span class="type">void</span>
    182. 

  182.     <span class="methodname"><a href="evstat.prev.html" class="methodname">prev</a></span>
    183. 

  183.     ( <span class="methodparam">void</span>
    184. 

  184.    )</div>
    185. 

  185. <div class="methodsynopsis dc-description">
    186. 

  186.    <span class="modifier">public</span>
    187. 

  187.    <span class="type">void</span>
    188. 

  188.     <span class="methodname"><a href="evstat.set.html" class="methodname">set</a></span>
    189. 

  189.     ( <span class="methodparam">
    190. 

  190.     <span class="type">string</span>
    191. 

  191.      <code class="parameter">$path</code>
    192. 

  192.    </span>
    193. 

  193.    , <span class="methodparam">
    194. 

  194.     <span class="type">double</span>
    195. 

  195.      <code class="parameter">$interval</code>
    196. 

  196.    </span>
    197. 

  197.    )</div>
    198. 

  198. <div class="methodsynopsis dc-description">
    199. 

  199.    <span class="modifier">public</span>
    200. 

  200.    <span class="type">bool</span>
    201. 

  201.     <span class="methodname"><a href="evstat.stat.html" class="methodname">stat</a></span>
    202. 

  202.     ( <span class="methodparam">void</span>
    203. 

  203.    )</div>
    204. 

  204. 

  205.     <div class="classsynopsisinfo classsynopsisinfo_comment">/* 继承的方法 */</div>
    206. 

  206.     <div class="methodsynopsis dc-description">
    207. 

  207.    <span class="modifier">public</span>
    208. 

  208.    <span class="type">int</span>
    209. 

  209.     <span class="methodname"><a href="evwatcher.clear.html" class="methodname">EvWatcher::clear</a></span>
    210. 

  210.     ( <span class="methodparam">void</span>
    211. 

  211.    )</div>
    212. 

  212. <div class="methodsynopsis dc-description">
    213. 

  213.    <span class="modifier">abstract</span>
    214. 

  214.    <span class="modifier">public</span>
    215. 

  215.     <span class="methodname"><a href="evwatcher.construct.html" class="methodname">EvWatcher::__construct</a></span>
    216. 

  216.     ( <span class="methodparam">void</span>
    217. 

  217.    )</div>
    218. 

  218. <div class="methodsynopsis dc-description">
    219. 

  219.    <span class="modifier">public</span>
    220. 

  220.    <span class="type">void</span>
    221. 

  221.     <span class="methodname"><a href="evwatcher.feed.html" class="methodname">EvWatcher::feed</a></span>
    222. 

  222.     ( <span class="methodparam">
    223. 

  223.     <span class="type">int</span>
    224. 

  224.      <code class="parameter">$revents</code>
    225. 

  225.    </span>
    226. 

  226.    )</div>
    227. 

  227. <div class="methodsynopsis dc-description">
    228. 

  228.    <span class="modifier">public</span>
    229. 

  229.    <span class="type">EvLoop</span>
    230. 

  230.     <span class="methodname"><a href="evwatcher.getloop.html" class="methodname">EvWatcher::getLoop</a></span>
    231. 

  231.     ( <span class="methodparam">void</span>
    232. 

  232.    )</div>
    233. 

  233. <div class="methodsynopsis dc-description">
    234. 

  234.    <span class="modifier">public</span>
    235. 

  235.    <span class="type">void</span>
    236. 

  236.     <span class="methodname"><a href="evwatcher.invoke.html" class="methodname">EvWatcher::invoke</a></span>
    237. 

  237.     ( <span class="methodparam">
    238. 

  238.     <span class="type">int</span>
    239. 

  239.      <code class="parameter">$revents</code>
    240. 

  240.    </span>
    241. 

  241.    )</div>
    242. 

  242. <div class="methodsynopsis dc-description">
    243. 

  243.    <span class="modifier">public</span>
    244. 

  244.    <span class="type">bool</span>
    245. 

  245.     <span class="methodname"><a href="evwatcher.keepalive.html" class="methodname">EvWatcher::keepalive</a></span>
    246. 

  246.     ([ <span class="methodparam">
    247. 

  247.     <span class="type">bool</span>
    248. 

  248.      <code class="parameter">$value</code>
    249. 

  249.    </span>
    250. 

  250.   ] )</div>
    251. 

  251. <div class="methodsynopsis dc-description">
    252. 

  252.    <span class="modifier">public</span>
    253. 

  253.    <span class="type">void</span>
    254. 

  254.     <span class="methodname"><a href="evwatcher.setcallback.html" class="methodname">EvWatcher::setCallback</a></span>
    255. 

  255.     ( <span class="methodparam">
    256. 

  256.     <span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span>
    257. 

  257.      <code class="parameter">$callback</code>
    258. 

  258.    </span>
    259. 

  259.    )</div>
    260. 

  260. <div class="methodsynopsis dc-description">
    261. 

  261.    <span class="modifier">public</span>
    262. 

  262.    <span class="type">void</span>
    263. 

  263.     <span class="methodname"><a href="evwatcher.start.html" class="methodname">EvWatcher::start</a></span>
    264. 

  264.     ( <span class="methodparam">void</span>
    265. 

  265.    )</div>
    266. 

  266. <div class="methodsynopsis dc-description">
    267. 

  267.    <span class="modifier">public</span>
    268. 

  268.    <span class="type">void</span>
    269. 

  269.     <span class="methodname"><a href="evwatcher.stop.html" class="methodname">EvWatcher::stop</a></span>
    270. 

  270.     ( <span class="methodparam">void</span>
    271. 

  271.    )</div>
    272. 

  272. 

  273.    }</div>
    274. 

  274. 

  275.   </div>
    276. 

  276. 

  277.   <div class="section" id="evstat.props">
    278. 

  278.    <h2 class="title">属性</h2>
    279. 

  279.    <dl>
    280. 

  280. 

  281.     <dt id="evstat.props.interval">
    282. 

  282.      <span class="term">
    283. 

  283.       <var class="varname"><var class="varname">interval</var></var>
    284. 

  284.      </span>
    285. 

  285.      <dd>
    286. 

  286. 

  287.       <p class="para">
    288. 

  288.        <em class="emphasis">Readonly</em>
    289. 

  289.        . Hint on how quickly a change is expected to be detected and should
    290. 

  290.        normally be specified as
    291. 

  291.        <strong><code>0.0</code></strong>
    292. 

  292.        to let
    293. 

  293.        <em class="emphasis">libev</em>
    294. 

  294.        choose a suitable value.
    295. 

  295.       </p>
    296. 

  296.      </dd>
    297. 

  297. 

  298.     </dt>
    299. 

  299. 

  300.     <dt id="evstat.props.path">
    301. 

  301.      <span class="term">
    302. 

  302.       <var class="varname"><var class="varname">path</var></var>
    303. 

  303.      </span>
    304. 

  304.      <dd>
    305. 

  305. 

  306.       <p class="para">
    307. 

  307.        <em class="emphasis">Readonly</em>
    308. 

  308.        . The path to wait for status changes on.
    309. 

  309.       </p>
    310. 

  310.      </dd>
    311. 

  311. 

  312.     </dt>
    313. 

  313. 

  314.    </dl>
    315. 

  315. 

  316.   </div>
    317. 

  317. 

  318.  </div>
    319. 

  319. 

  320.  
    321. 

  321. 

  322. 

  323. 

  324. 

  325. 

  326. 

  327. 

  328. 

  329. 

  330. 

  331. 

  332. 

  333. 

  334. 

  335. 

  336. 

  337. 

  338. 

  339. 

  340. 

  341. 

  342. 

  343. 

  344. 

  345. 

  346. 

  347. 

  348. 

  349. 

  350. 

  351. 

  352. <h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="evstat.attr.html">EvStat::attr</a> — Returns the values most recently detected by Ev</li><li><a href="evstat.construct.html">EvStat::__construct</a> — Constructs EvStat watcher object</li><li><a href="evstat.createstopped.html">EvStat::createStopped</a> — Create a stopped EvStat watcher object</li><li><a href="evstat.prev.html">EvStat::prev</a> — Returns the previous set of values returned by EvStat::attr</li><li><a href="evstat.set.html">EvStat::set</a> — Configures the watcher</li><li><a href="evstat.stat.html">EvStat::stat</a> — Initiates the stat call</li></ul>
    353. 

  353. </div>
    354. 

  354. <hr /><div class="manualnavbar" style="text-align: center;">
    355. 

  355.  <div class="prev" style="text-align: left; float: left;"><a href="evsignal.set.html">EvSignal::set</a></div>
    356. 

  356.  <div class="next" style="text-align: right; float: right;"><a href="evstat.attr.html">EvStat::attr</a></div>
    357. 

  357.  <div class="up"><a href="book.ev.html">Ev</a></div>
    358. 

  358.  <div class="home"><a href="index.html">PHP Manual</a></div>
    359. 

  359. </div></body></html>
    360. 

  360.