Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(507)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/experimental.processes.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « chrome/common/extensions/docs/experimental.privacy.html ('k') | chrome/common/extensions/docs/experimental.record.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the
4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script>
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <meta name="description" content="Documentation for the chrome.experimental.pr ocesses module, which is part of the Google Chrome extension APIs."><title>chro me.experimental.processes - Google Chrome Extensions - Google Code</title></head >
22 <body> <div id="devModeWarning" class="displayModeWarning">
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
24 </div>
25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser">
29 <option>Choose a different version...
30 </option><option value="">Stable
31 </option><option value="beta">Beta
32 </option><option value="dev">Dev
33 </option><option value="trunk">Trunk
34 </option></select>
35 </div>
36 <div id="unofficialWarning" class="displayModeWarning">
37 <span>WARNING: This is unofficial documentation. It may not work with the
38 current release of Chrome.</span>
39 <button id="goToOfficialDocs">Go to the official docs</button>
40 </div>
41 <div id="gc-container" class="labs">
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
43 <!-- In particular, sub-templates that recurse, must be used by allowing
44 jstemplate to make a copy of the template in this section which
45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a>
48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a>
51 </div>
52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr>
55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
56 <td valign="middle" width="100%" style="padding-left:0.6em;">
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
63 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div>
66 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td>
72 </tr>
73 </tbody></table>
74 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
78 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
81 </li>
82 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
84 </li>
85 <li id="faq_link">
86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
87 </li>
88 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
90 </li>
91 <li id="group_link">
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li>
94 <li id="so_link">
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li>
97 </ul>
98 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170">
100 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc">
102 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li>
104 <li><a href="overview.html">Overview</a></li>
105 <li><a href="whats_new.html">What's New?</a></li>
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
107 <ul>
108 <li>Browser UI
109 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li >
113 <li><a href="omnibox.html">Omnibox</a></li>
114 <li><a href="options.html">Options Pages</a></li>
115 <li><a href="override.html">Override Pages</a></li>
116 <li><a href="pageAction.html">Page Actions</a></li>
117 </ul>
118 </li>
119 <li>Browser Interaction
120 <ul>
121 <li><a href="bookmarks.html">Bookmarks</a></li>
122 <li><a href="cookies.html">Cookies</a></li>
123 <li><a href="devtools.html">Developer Tools</a></li>
124 <li><a href="events.html">Events</a></li>
125 <li><a href="history.html">History</a></li>
126 <li><a href="management.html">Management</a></li>
127 <li><a href="tabs.html">Tabs</a></li>
128 <li><a href="windows.html">Windows</a></li>
129 </ul>
130 </li>
131 <li>Implementation
132 <ul>
133 <li><a href="a11y.html">Accessibility</a></li>
134 <li><a href="background_pages.html">Background Pages</a></li>
135 <li><a href="content_scripts.html">Content Scripts</a></li>
136 <li><a href="xhr.html">Cross-Origin XHR</a></li>
137 <li><a href="i18n.html">Internationalization</a></li>
138 <li><a href="messaging.html">Message Passing</a></li>
139 <li><a href="permissions.html">Optional Permissions</a></li>
140 <li><a href="npapi.html">NPAPI Plugins</a></li>
141 </ul>
142 </li>
143 <li>Finishing
144 <ul>
145 <li><a href="hosting.html">Hosting</a></li>
146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
147 </ul>
148 </li>
149 </ul>
150 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul>
158 </li>
159 <li><h2>Reference</h2>
160 <ul>
161 <li>Formats
162 <ul>
163 <li><a href="manifest.html">Manifest Files</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li>
165 </ul>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li><a href="api_index.html">chrome.* APIs</a></li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul>
171 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li>
173 <div class="line"> </div>
174 <li><h2>More</h2>
175 <ul>
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
178 <li><a href="themes.html">Themes</a></li>
179 </ul>
180 </li>
181 </ul>
182 </div>
183 <script>
184 initToggles();
185 </script>
186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle">
188 <h1 class="page_title">chrome.experimental.processes</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#apiReference">API reference: chrome.experimental.proce sses</a>
196 <ol>
197 <li>
198 <a href="#global-methods">Methods</a>
199 <ol>
200 <li>
201 <a href="#method-getProcessIdForTab">getProcessIdForTab</a>
202 </li><li>
203 <a href="#method-getProcessInfo">getProcessInfo</a>
204 </li><li>
205 <a href="#method-terminate">terminate</a>
206 </li>
207 </ol>
208 </li>
209 <li>
210 <a href="#global-events">Events</a>
211 <ol>
212 <li>
213 <a href="#event-onCreated">onCreated</a>
214 </li><li>
215 <a href="#event-onExited">onExited</a>
216 </li><li>
217 <a href="#event-onUnresponsive">onUnresponsive</a>
218 </li><li>
219 <a href="#event-onUpdated">onUpdated</a>
220 </li><li>
221 <a href="#event-onUpdatedWithMemory">onUpdatedWithMemory</a>
222 </li>
223 </ol>
224 </li>
225 <li>
226 <a href="#types">Types</a>
227 <ol>
228 <li>
229 <a href="#type-Process">Process</a>
230 <ol>
231 </ol>
232 </li><li>
233 <a href="#type-Cache">Cache</a>
234 <ol>
235 </ol>
236 </li>
237 </ol>
238 </li>
239 </ol>
240 </li>
241 </ol>
242 </div>
243 <!-- /TABLE OF CONTENTS -->
244 <!-- Standard content lead-in for experimental API pages -->
245 <p id="classSummary">
246 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
247 </p>
248 <!-- STATIC CONTENT PLACEHOLDER -->
249 <div id="static"></div>
250 <!-- API PAGE -->
251 <div class="apiPage">
252 <a name="apiReference"></a>
253 <h2>API reference: chrome.experimental.processes</h2>
254 <!-- PROPERTIES -->
255 <!-- /apiGroup -->
256 <!-- METHODS -->
257 <div id="methodsTemplate" class="apiGroup">
258 <a name="global-methods"></a>
259 <h3>Methods</h3>
260 <!-- iterates over all functions -->
261 <div class="apiItem">
262 <a name="method-getProcessIdForTab"></a> <!-- method-anchor -->
263 <h4>getProcessIdForTab</h4>
264 <div class="summary">
265 <!-- Note: intentionally longer 80 columns -->
266 <span>chrome.experimental.processes.getProcessIdForTab</span>( <span class="null"><span>integer</span>
267 <var><span>tabId</span></var></span><span class="null"><sp an>, </span><span>function</span>
268 <var><span>callback</span></var></span>)</div>
269 <div class="description">
270 <p>Returns the ID of the renderer process for the specified tab. </p>
271 <!-- PARAMETERS -->
272 <h4>Parameters</h4>
273 <dl>
274 <div>
275 <div>
276 <dt>
277 <var>tabId</var>
278 <em>
279 <!-- TYPE -->
280 <div style="display:inline">
281 (
282 <span id="typeTemplate">
283 <span>
284 <span>integer</span>
285 </span>
286 </span>
287 )
288 </div>
289 </em>
290 </dt>
291 <dd>The ID of the tab for which the renderer process ID is to be retur ned.</dd>
292 <!-- OBJECT PROPERTIES -->
293 <!-- OBJECT METHODS -->
294 <!-- OBJECT EVENT FIELDS -->
295 <!-- FUNCTION PARAMETERS -->
296 </div>
297 </div><div>
298 <div>
299 <dt>
300 <var>callback</var>
301 <em>
302 <!-- TYPE -->
303 <div style="display:inline">
304 (
305 <span id="typeTemplate">
306 <span>
307 <span>function</span>
308 </span>
309 </span>
310 )
311 </div>
312 </em>
313 </dt>
314 <dd class="todo">
315 Undocumented.
316 </dd>
317 <!-- OBJECT PROPERTIES -->
318 <!-- OBJECT METHODS -->
319 <!-- OBJECT EVENT FIELDS -->
320 <!-- FUNCTION PARAMETERS -->
321 </div>
322 </div>
323 </dl>
324 <!-- RETURNS -->
325 <dl>
326 </dl>
327 <!-- CALLBACK -->
328 <div>
329 <div>
330 <h4>Callback function</h4>
331 <p>
332 The <em>callback</em> parameter should specify a function
333 that looks like this:
334 </p>
335 <!-- Note: intentionally longer 80 columns -->
336 <pre>function(<span>integer processId</span>) <span class="sub dued">{...}</span>;</pre>
337 <dl>
338 <div>
339 <div>
340 <dt>
341 <var>processId</var>
342 <em>
343 <!-- TYPE -->
344 <div style="display:inline">
345 (
346 <span id="typeTemplate">
347 <span>
348 <span>integer</span>
349 </span>
350 </span>
351 )
352 </div>
353 </em>
354 </dt>
355 <dd>Process ID of the tab's renderer process.</dd>
356 <!-- OBJECT PROPERTIES -->
357 <!-- OBJECT METHODS -->
358 <!-- OBJECT EVENT FIELDS -->
359 <!-- FUNCTION PARAMETERS -->
360 </div>
361 </div>
362 </dl>
363 </div>
364 </div>
365 <!-- MIN_VERSION -->
366 </div> <!-- /description -->
367 </div><div class="apiItem">
368 <a name="method-getProcessInfo"></a> <!-- method-anchor -->
369 <h4>getProcessInfo</h4>
370 <div class="summary">
371 <!-- Note: intentionally longer 80 columns -->
372 <span>chrome.experimental.processes.getProcessInfo</span>(<spa n class="null"><span>integer or array of integer</span>
373 <var><span>processIds</span></var></span><span class="null "><span>, </span><span>boolean</span>
374 <var><span>includeMemory</span></var></span><span class="n ull"><span>, </span><span>function</span>
375 <var><span>callback</span></var></span>)</div>
376 <div class="description">
377 <p>Retrieves the process information for each process ID specifi ed.</p>
378 <!-- PARAMETERS -->
379 <h4>Parameters</h4>
380 <dl>
381 <div>
382 <div>
383 <dt>
384 <var>processIds</var>
385 <em>
386 <!-- TYPE -->
387 <div style="display:inline">
388 (
389 <span id="typeTemplate">
390 <span>
391 <span>integer or array of integer</span>
392 </span>
393 </span>
394 )
395 </div>
396 </em>
397 </dt>
398 <dd>The list of process IDs or single process ID for which to return t he process information. An empty list indicates all processes are requested.</dd >
399 <!-- OBJECT PROPERTIES -->
400 <!-- OBJECT METHODS -->
401 <!-- OBJECT EVENT FIELDS -->
402 <!-- FUNCTION PARAMETERS -->
403 </div>
404 </div><div>
405 <div>
406 <dt>
407 <var>includeMemory</var>
408 <em>
409 <!-- TYPE -->
410 <div style="display:inline">
411 (
412 <span id="typeTemplate">
413 <span>
414 <span>boolean</span>
415 </span>
416 </span>
417 )
418 </div>
419 </em>
420 </dt>
421 <dd>True if detailed memory usage is required. Note, collecting memory usage information incurs extra CPU usage and should only be queried for when ne eded.</dd>
422 <!-- OBJECT PROPERTIES -->
423 <!-- OBJECT METHODS -->
424 <!-- OBJECT EVENT FIELDS -->
425 <!-- FUNCTION PARAMETERS -->
426 </div>
427 </div><div>
428 <div>
429 <dt>
430 <var>callback</var>
431 <em>
432 <!-- TYPE -->
433 <div style="display:inline">
434 (
435 <span id="typeTemplate">
436 <span>
437 <span>function</span>
438 </span>
439 </span>
440 )
441 </div>
442 </em>
443 </dt>
444 <dd>Called when the processes information is collected.</dd>
445 <!-- OBJECT PROPERTIES -->
446 <!-- OBJECT METHODS -->
447 <!-- OBJECT EVENT FIELDS -->
448 <!-- FUNCTION PARAMETERS -->
449 </div>
450 </div>
451 </dl>
452 <!-- RETURNS -->
453 <dl>
454 </dl>
455 <!-- CALLBACK -->
456 <div>
457 <div>
458 <h4>Callback function</h4>
459 <p>
460 The <em>callback</em> parameter should specify a function
461 that looks like this:
462 </p>
463 <!-- Note: intentionally longer 80 columns -->
464 <pre>function(<span>object processes</span>) <span class="subd ued">{...}</span>;</pre>
465 <dl>
466 <div>
467 <div>
468 <dt>
469 <var>processes</var>
470 <em>
471 <!-- TYPE -->
472 <div style="display:inline">
473 (
474 <span id="typeTemplate">
475 <span>
476 <span>object</span>
477 </span>
478 </span>
479 )
480 </div>
481 </em>
482 </dt>
483 <dd>A dictionary of Process objects for each requested process that is a live child process of the current browser process, indexed by process ID. Met rics requiring aggregation over time will not be populated in each Process objec t.</dd>
484 <!-- OBJECT PROPERTIES -->
485 <!-- OBJECT METHODS -->
486 <!-- OBJECT EVENT FIELDS -->
487 <!-- FUNCTION PARAMETERS -->
488 </div>
489 </div>
490 </dl>
491 </div>
492 </div>
493 <!-- MIN_VERSION -->
494 </div> <!-- /description -->
495 </div><div class="apiItem">
496 <a name="method-terminate"></a> <!-- method-anchor -->
497 <h4>terminate</h4>
498 <div class="summary">
499 <!-- Note: intentionally longer 80 columns -->
500 <span>chrome.experimental.processes.terminate</span>(<span cla ss="null"><span>integer</span>
501 <var><span>processId</span></var></span><span class="optio nal"><span>, </span><span>function</span>
502 <var><span>callback</span></var></span>)</div>
503 <div class="description">
504 <p>Terminates the specified renderer process. Equivalent to visi ting about:crash, but without changing the tab's URL.</p>
505 <!-- PARAMETERS -->
506 <h4>Parameters</h4>
507 <dl>
508 <div>
509 <div>
510 <dt>
511 <var>processId</var>
512 <em>
513 <!-- TYPE -->
514 <div style="display:inline">
515 (
516 <span id="typeTemplate">
517 <span>
518 <span>integer</span>
519 </span>
520 </span>
521 )
522 </div>
523 </em>
524 </dt>
525 <dd>The ID of the process to be terminated.</dd>
526 <!-- OBJECT PROPERTIES -->
527 <!-- OBJECT METHODS -->
528 <!-- OBJECT EVENT FIELDS -->
529 <!-- FUNCTION PARAMETERS -->
530 </div>
531 </div><div>
532 <div>
533 <dt>
534 <var>callback</var>
535 <em>
536 <!-- TYPE -->
537 <div style="display:inline">
538 (
539 <span class="optional">optional</span>
540 <span id="typeTemplate">
541 <span>
542 <span>function</span>
543 </span>
544 </span>
545 )
546 </div>
547 </em>
548 </dt>
549 <dd class="todo">
550 Undocumented.
551 </dd>
552 <!-- OBJECT PROPERTIES -->
553 <!-- OBJECT METHODS -->
554 <!-- OBJECT EVENT FIELDS -->
555 <!-- FUNCTION PARAMETERS -->
556 </div>
557 </div>
558 </dl>
559 <!-- RETURNS -->
560 <dl>
561 </dl>
562 <!-- CALLBACK -->
563 <div>
564 <div>
565 <h4>Callback function</h4>
566 <p>
567 If you specify the <em>callback</em> parameter, it should
568 specify a function that looks like this:
569 </p>
570 <!-- Note: intentionally longer 80 columns -->
571 <pre>function(<span>boolean didTerminate</span>) <span class=" subdued">{...}</span>;</pre>
572 <dl>
573 <div>
574 <div>
575 <dt>
576 <var>didTerminate</var>
577 <em>
578 <!-- TYPE -->
579 <div style="display:inline">
580 (
581 <span id="typeTemplate">
582 <span>
583 <span>boolean</span>
584 </span>
585 </span>
586 )
587 </div>
588 </em>
589 </dt>
590 <dd>True if terminating the process was successful, otherwise false.</ dd>
591 <!-- OBJECT PROPERTIES -->
592 <!-- OBJECT METHODS -->
593 <!-- OBJECT EVENT FIELDS -->
594 <!-- FUNCTION PARAMETERS -->
595 </div>
596 </div>
597 </dl>
598 </div>
599 </div>
600 <!-- MIN_VERSION -->
601 </div> <!-- /description -->
602 </div> <!-- /apiItem -->
603 </div> <!-- /apiGroup -->
604 <!-- EVENTS -->
605 <div id="eventsTemplate" class="apiGroup">
606 <a name="global-events"></a>
607 <h3>Events</h3>
608 <!-- iterates over all events -->
609 <div class="apiItem">
610 <a name="event-onCreated"></a>
611 <h4>onCreated</h4>
612 <div class="summary">
613 <!-- Note: intentionally longer 80 columns -->
614 <span class="subdued">chrome.experimental.processes.</span><span >onCreated</span><span class="subdued">.addListener</span>(function(<span>Proces s process</span>) <span class="subdued">{...}</span><span></span>);
615 </div>
616 <div class="description">
617 <p>Fired each time a process is created, providing the corrsepon ding Process object.</p>
618 <!-- LISTENER PARAMETERS -->
619 <div>
620 <h4>Listener parameters</h4>
621 <dl>
622 <div>
623 <div>
624 <dt>
625 <var>process</var>
626 <em>
627 <!-- TYPE -->
628 <div style="display:inline">
629 (
630 <span id="typeTemplate">
631 <span>
632 <a href="experimental.processes.html#type-Process">Proce ss</a>
633 </span>
634 </span>
635 )
636 </div>
637 </em>
638 </dt>
639 <dd>Details of the process that was created. Metrics requiring aggrega tion over time will not be populated in the object.</dd>
640 <!-- OBJECT PROPERTIES -->
641 <!-- OBJECT METHODS -->
642 <!-- OBJECT EVENT FIELDS -->
643 <!-- FUNCTION PARAMETERS -->
644 </div>
645 </div>
646 </dl>
647 </div>
648 <!-- EXTRA PARAMETERS -->
649 <!-- LISTENER RETURN VALUE -->
650 <dl>
651 </dl>
652 </div> <!-- /description -->
653 <!-- /description -->
654 </div><div class="apiItem">
655 <a name="event-onExited"></a>
656 <h4>onExited</h4>
657 <div class="summary">
658 <!-- Note: intentionally longer 80 columns -->
659 <span class="subdued">chrome.experimental.processes.</span><span >onExited</span><span class="subdued">.addListener</span>(function(<span>integer processId, integer exitType, integer exitCode</span>) <span class="subdued">{.. .}</span><span></span>);
660 </div>
661 <div class="description">
662 <p>Fired each time a process is terminated, providing the type o f exit.</p>
663 <!-- LISTENER PARAMETERS -->
664 <div>
665 <h4>Listener parameters</h4>
666 <dl>
667 <div>
668 <div>
669 <dt>
670 <var>processId</var>
671 <em>
672 <!-- TYPE -->
673 <div style="display:inline">
674 (
675 <span id="typeTemplate">
676 <span>
677 <span>integer</span>
678 </span>
679 </span>
680 )
681 </div>
682 </em>
683 </dt>
684 <dd>The ID of the process that exited.</dd>
685 <!-- OBJECT PROPERTIES -->
686 <!-- OBJECT METHODS -->
687 <!-- OBJECT EVENT FIELDS -->
688 <!-- FUNCTION PARAMETERS -->
689 </div>
690 </div><div>
691 <div>
692 <dt>
693 <var>exitType</var>
694 <em>
695 <!-- TYPE -->
696 <div style="display:inline">
697 (
698 <span id="typeTemplate">
699 <span>
700 <span>integer</span>
701 </span>
702 </span>
703 )
704 </div>
705 </em>
706 </dt>
707 <dd>The type of exit that occurred for the process - normal, abnormal, killed, crashed. Only available for renderer processes.</dd>
708 <!-- OBJECT PROPERTIES -->
709 <!-- OBJECT METHODS -->
710 <!-- OBJECT EVENT FIELDS -->
711 <!-- FUNCTION PARAMETERS -->
712 </div>
713 </div><div>
714 <div>
715 <dt>
716 <var>exitCode</var>
717 <em>
718 <!-- TYPE -->
719 <div style="display:inline">
720 (
721 <span id="typeTemplate">
722 <span>
723 <span>integer</span>
724 </span>
725 </span>
726 )
727 </div>
728 </em>
729 </dt>
730 <dd>The exit code if the process exited abnormally. Only available for renderer processes.</dd>
731 <!-- OBJECT PROPERTIES -->
732 <!-- OBJECT METHODS -->
733 <!-- OBJECT EVENT FIELDS -->
734 <!-- FUNCTION PARAMETERS -->
735 </div>
736 </div>
737 </dl>
738 </div>
739 <!-- EXTRA PARAMETERS -->
740 <!-- LISTENER RETURN VALUE -->
741 <dl>
742 </dl>
743 </div> <!-- /description -->
744 <!-- /description -->
745 </div><div class="apiItem">
746 <a name="event-onUnresponsive"></a>
747 <h4>onUnresponsive</h4>
748 <div class="summary">
749 <!-- Note: intentionally longer 80 columns -->
750 <span class="subdued">chrome.experimental.processes.</span><span >onUnresponsive</span><span class="subdued">.addListener</span>(function(<span>P rocess process</span>) <span class="subdued">{...}</span><span></span>);
751 </div>
752 <div class="description">
753 <p>Fired each time a process becomes unresponsive, providing the corrseponding Process object.</p>
754 <!-- LISTENER PARAMETERS -->
755 <div>
756 <h4>Listener parameters</h4>
757 <dl>
758 <div>
759 <div>
760 <dt>
761 <var>process</var>
762 <em>
763 <!-- TYPE -->
764 <div style="display:inline">
765 (
766 <span id="typeTemplate">
767 <span>
768 <a href="experimental.processes.html#type-Process">Proce ss</a>
769 </span>
770 </span>
771 )
772 </div>
773 </em>
774 </dt>
775 <dd>Details of the unresponsive process. Metrics requiring aggregation over time will not be populated in the object. Only available for renderer proc esses.</dd>
776 <!-- OBJECT PROPERTIES -->
777 <!-- OBJECT METHODS -->
778 <!-- OBJECT EVENT FIELDS -->
779 <!-- FUNCTION PARAMETERS -->
780 </div>
781 </div>
782 </dl>
783 </div>
784 <!-- EXTRA PARAMETERS -->
785 <!-- LISTENER RETURN VALUE -->
786 <dl>
787 </dl>
788 </div> <!-- /description -->
789 <!-- /description -->
790 </div><div class="apiItem">
791 <a name="event-onUpdated"></a>
792 <h4>onUpdated</h4>
793 <div class="summary">
794 <!-- Note: intentionally longer 80 columns -->
795 <span class="subdued">chrome.experimental.processes.</span><span >onUpdated</span><span class="subdued">.addListener</span>(function(<span>object processes</span>) <span class="subdued">{...}</span><span></span>);
796 </div>
797 <div class="description">
798 <p>Fired each time the Task Manager updates its process statisti cs, providing the dictionary of updated Process objects, indexed by process ID.< /p>
799 <!-- LISTENER PARAMETERS -->
800 <div>
801 <h4>Listener parameters</h4>
802 <dl>
803 <div>
804 <div>
805 <dt>
806 <var>processes</var>
807 <em>
808 <!-- TYPE -->
809 <div style="display:inline">
810 (
811 <span id="typeTemplate">
812 <span>
813 <span>object</span>
814 </span>
815 </span>
816 )
817 </div>
818 </em>
819 </dt>
820 <dd>A dictionary of updated Process objects for each live process in t he browser, indexed by process ID. Metrics requiring aggregation over time will be populated in each Process object.</dd>
821 <!-- OBJECT PROPERTIES -->
822 <!-- OBJECT METHODS -->
823 <!-- OBJECT EVENT FIELDS -->
824 <!-- FUNCTION PARAMETERS -->
825 </div>
826 </div>
827 </dl>
828 </div>
829 <!-- EXTRA PARAMETERS -->
830 <!-- LISTENER RETURN VALUE -->
831 <dl>
832 </dl>
833 </div> <!-- /description -->
834 <!-- /description -->
835 </div><div class="apiItem">
836 <a name="event-onUpdatedWithMemory"></a>
837 <h4>onUpdatedWithMemory</h4>
838 <div class="summary">
839 <!-- Note: intentionally longer 80 columns -->
840 <span class="subdued">chrome.experimental.processes.</span><span >onUpdatedWithMemory</span><span class="subdued">.addListener</span>(function(<s pan>object processes</span>) <span class="subdued">{...}</span><span></span>);
841 </div>
842 <div class="description">
843 <p>Fired each time the Task Manager updates its process statisti cs, providing the dictionary of updated Process objects, indexed by process ID. Identical to onUpdate, with the addition of memory usage details included in eac h Process object. Note, collecting memory usage information incurs extra CPU usa ge and should only be listened for when needed.</p>
844 <!-- LISTENER PARAMETERS -->
845 <div>
846 <h4>Listener parameters</h4>
847 <dl>
848 <div>
849 <div>
850 <dt>
851 <var>processes</var>
852 <em>
853 <!-- TYPE -->
854 <div style="display:inline">
855 (
856 <span id="typeTemplate">
857 <span>
858 <span>object</span>
859 </span>
860 </span>
861 )
862 </div>
863 </em>
864 </dt>
865 <dd>A dictionary of updated Process objects for each live process in t he browser, indexed by process ID. Memory usage details will be included in eac h Process object.</dd>
866 <!-- OBJECT PROPERTIES -->
867 <!-- OBJECT METHODS -->
868 <!-- OBJECT EVENT FIELDS -->
869 <!-- FUNCTION PARAMETERS -->
870 </div>
871 </div>
872 </dl>
873 </div>
874 <!-- EXTRA PARAMETERS -->
875 <!-- LISTENER RETURN VALUE -->
876 <dl>
877 </dl>
878 </div> <!-- /description -->
879 <!-- /description -->
880 </div> <!-- /apiItem -->
881 </div> <!-- /apiGroup -->
882 <!-- TYPES -->
883 <div class="apiGroup">
884 <a name="types"></a>
885 <h3 id="types">Types</h3>
886 <!-- iterates over all types -->
887 <div class="apiItem">
888 <a name="type-Process"></a>
889 <h4>Process</h4>
890 <div>
891 <dt>
892 <em>
893 <!-- TYPE -->
894 <div style="display:inline">
895 (
896 <span id="typeTemplate">
897 <span>
898 <span>object</span>
899 </span>
900 </span>
901 )
902 </div>
903 </em>
904 </dt>
905 <dd>An object containing information about one of the browser's proces ses.</dd>
906 <!-- OBJECT PROPERTIES -->
907 <dd>
908 <dl>
909 <div>
910 <div>
911 <dt>
912 <var>id</var>
913 <em>
914 <!-- TYPE -->
915 <div style="display:inline">
916 (
917 <span id="typeTemplate">
918 <span>
919 <span>integer</span>
920 </span>
921 </span>
922 )
923 </div>
924 </em>
925 </dt>
926 <dd>Unique ID of the process provided by the browser.</dd>
927 <!-- OBJECT PROPERTIES -->
928 <!-- OBJECT METHODS -->
929 <!-- OBJECT EVENT FIELDS -->
930 <!-- FUNCTION PARAMETERS -->
931 </div>
932 </div><div>
933 <div>
934 <dt>
935 <var>osProcessId</var>
936 <em>
937 <!-- TYPE -->
938 <div style="display:inline">
939 (
940 <span id="typeTemplate">
941 <span>
942 <span>integer</span>
943 </span>
944 </span>
945 )
946 </div>
947 </em>
948 </dt>
949 <dd>The ID of the process, as provided by the OS.</dd>
950 <!-- OBJECT PROPERTIES -->
951 <!-- OBJECT METHODS -->
952 <!-- OBJECT EVENT FIELDS -->
953 <!-- FUNCTION PARAMETERS -->
954 </div>
955 </div><div>
956 <div>
957 <dt>
958 <var>type</var>
959 <em>
960 <!-- TYPE -->
961 <div style="display:inline">
962 (
963 <span class="enum">enumerated</span>
964 <span id="typeTemplate">
965 <span>
966 <span>string</span>
967 <span>["browser", "renderer", "extension", "notification ", "plugin", "worker", "nacl", "utility", "gpu", "other"]</span>
968 </span>
969 </span>
970 )
971 </div>
972 </em>
973 </dt>
974 <dd>The type of process.</dd>
975 <!-- OBJECT PROPERTIES -->
976 <!-- OBJECT METHODS -->
977 <!-- OBJECT EVENT FIELDS -->
978 <!-- FUNCTION PARAMETERS -->
979 </div>
980 </div><div>
981 <div>
982 <dt>
983 <var>profile</var>
984 <em>
985 <!-- TYPE -->
986 <div style="display:inline">
987 (
988 <span id="typeTemplate">
989 <span>
990 <span>string</span>
991 </span>
992 </span>
993 )
994 </div>
995 </em>
996 </dt>
997 <dd>The profile which the process is associated with.</dd>
998 <!-- OBJECT PROPERTIES -->
999 <!-- OBJECT METHODS -->
1000 <!-- OBJECT EVENT FIELDS -->
1001 <!-- FUNCTION PARAMETERS -->
1002 </div>
1003 </div><div>
1004 <div>
1005 <dt>
1006 <var>tabs</var>
1007 <em>
1008 <!-- TYPE -->
1009 <div style="display:inline">
1010 (
1011 <span id="typeTemplate">
1012 <span>
1013 <span>
1014 array of <span><span>
1015 <span>
1016 <span>integer</span>
1017 </span>
1018 </span></span>
1019 </span>
1020 </span>
1021 </span>
1022 )
1023 </div>
1024 </em>
1025 </dt>
1026 <dd>Array of Tab IDs that have a page rendered by this process. The li st will be non-empty for renderer processes only.</dd>
1027 <!-- OBJECT PROPERTIES -->
1028 <!-- OBJECT METHODS -->
1029 <!-- OBJECT EVENT FIELDS -->
1030 <!-- FUNCTION PARAMETERS -->
1031 </div>
1032 </div><div>
1033 <div>
1034 <dt>
1035 <var>cpu</var>
1036 <em>
1037 <!-- TYPE -->
1038 <div style="display:inline">
1039 (
1040 <span class="optional">optional</span>
1041 <span id="typeTemplate">
1042 <span>
1043 <span>number</span>
1044 </span>
1045 </span>
1046 )
1047 </div>
1048 </em>
1049 </dt>
1050 <dd>The most recent measurement of the process CPU usage, between 0 an d 100%. Only available when receiving the object as part of a callback from onUp dated or onUpdatedWithMemory.</dd>
1051 <!-- OBJECT PROPERTIES -->
1052 <!-- OBJECT METHODS -->
1053 <!-- OBJECT EVENT FIELDS -->
1054 <!-- FUNCTION PARAMETERS -->
1055 </div>
1056 </div><div>
1057 <div>
1058 <dt>
1059 <var>network</var>
1060 <em>
1061 <!-- TYPE -->
1062 <div style="display:inline">
1063 (
1064 <span class="optional">optional</span>
1065 <span id="typeTemplate">
1066 <span>
1067 <span>number</span>
1068 </span>
1069 </span>
1070 )
1071 </div>
1072 </em>
1073 </dt>
1074 <dd>The most recent measurement of the process network usage, in bytes per second. Only available when receiving the object as part of a callback from onUpdated or onUpdatedWithMemory.</dd>
1075 <!-- OBJECT PROPERTIES -->
1076 <!-- OBJECT METHODS -->
1077 <!-- OBJECT EVENT FIELDS -->
1078 <!-- FUNCTION PARAMETERS -->
1079 </div>
1080 </div><div>
1081 <div>
1082 <dt>
1083 <var>privateMemory</var>
1084 <em>
1085 <!-- TYPE -->
1086 <div style="display:inline">
1087 (
1088 <span class="optional">optional</span>
1089 <span id="typeTemplate">
1090 <span>
1091 <span>number</span>
1092 </span>
1093 </span>
1094 )
1095 </div>
1096 </em>
1097 </dt>
1098 <dd>The most recent measurement of the process private memory usage, i n bytes. Only available when receiving the object as part of a callback from onU pdatedWithMemory or getProcessInfo with the includeMemory flag.</dd>
1099 <!-- OBJECT PROPERTIES -->
1100 <!-- OBJECT METHODS -->
1101 <!-- OBJECT EVENT FIELDS -->
1102 <!-- FUNCTION PARAMETERS -->
1103 </div>
1104 </div><div>
1105 <div>
1106 <dt>
1107 <var>jsMemoryAllocated</var>
1108 <em>
1109 <!-- TYPE -->
1110 <div style="display:inline">
1111 (
1112 <span class="optional">optional</span>
1113 <span id="typeTemplate">
1114 <span>
1115 <span>number</span>
1116 </span>
1117 </span>
1118 )
1119 </div>
1120 </em>
1121 </dt>
1122 <dd>The most recent measurement of the process JavaScript allocated me mory, in bytes. Only available when receiving the object as part of a callback f rom onUpdated or onUpdatedWithMemory.</dd>
1123 <!-- OBJECT PROPERTIES -->
1124 <!-- OBJECT METHODS -->
1125 <!-- OBJECT EVENT FIELDS -->
1126 <!-- FUNCTION PARAMETERS -->
1127 </div>
1128 </div><div>
1129 <div>
1130 <dt>
1131 <var>jsMemoryUsed</var>
1132 <em>
1133 <!-- TYPE -->
1134 <div style="display:inline">
1135 (
1136 <span class="optional">optional</span>
1137 <span id="typeTemplate">
1138 <span>
1139 <span>number</span>
1140 </span>
1141 </span>
1142 )
1143 </div>
1144 </em>
1145 </dt>
1146 <dd>The most recent measurement of the process JavaScript memory used, in bytes. Only available when receiving the object as part of a callback from o nUpdated or onUpdatedWithMemory.</dd>
1147 <!-- OBJECT PROPERTIES -->
1148 <!-- OBJECT METHODS -->
1149 <!-- OBJECT EVENT FIELDS -->
1150 <!-- FUNCTION PARAMETERS -->
1151 </div>
1152 </div><div>
1153 <div>
1154 <dt>
1155 <var>sqliteMemory</var>
1156 <em>
1157 <!-- TYPE -->
1158 <div style="display:inline">
1159 (
1160 <span class="optional">optional</span>
1161 <span id="typeTemplate">
1162 <span>
1163 <span>number</span>
1164 </span>
1165 </span>
1166 )
1167 </div>
1168 </em>
1169 </dt>
1170 <dd>The most recent measurement of the process’s SQLite memory usage, in bytes. Only available when receiving the object as part of a callback from on Updated or onUpdatedWithMemory.</dd>
1171 <!-- OBJECT PROPERTIES -->
1172 <!-- OBJECT METHODS -->
1173 <!-- OBJECT EVENT FIELDS -->
1174 <!-- FUNCTION PARAMETERS -->
1175 </div>
1176 </div><div>
1177 <div>
1178 <dt>
1179 <var>fps</var>
1180 <em>
1181 <!-- TYPE -->
1182 <div style="display:inline">
1183 (
1184 <span class="optional">optional</span>
1185 <span id="typeTemplate">
1186 <span>
1187 <span>number</span>
1188 </span>
1189 </span>
1190 )
1191 </div>
1192 </em>
1193 </dt>
1194 <dd>The most recent measurement of the process frames per second. Only available when receiving the object as part of a callback from onUpdated or onU pdatedWithMemory.</dd>
1195 <!-- OBJECT PROPERTIES -->
1196 <!-- OBJECT METHODS -->
1197 <!-- OBJECT EVENT FIELDS -->
1198 <!-- FUNCTION PARAMETERS -->
1199 </div>
1200 </div><div>
1201 <div>
1202 <dt>
1203 <var>imageCache</var>
1204 <em>
1205 <!-- TYPE -->
1206 <div style="display:inline">
1207 (
1208 <span class="optional">optional</span>
1209 <span id="typeTemplate">
1210 <span>
1211 <a href="experimental.processes.html#type-Cache">Cache</ a>
1212 </span>
1213 </span>
1214 )
1215 </div>
1216 </em>
1217 </dt>
1218 <dd>The most recent information about the image cache for the process. Only available when receiving the object as part of a callback from onUpdated o r onUpdatedWithMemory.</dd>
1219 <!-- OBJECT PROPERTIES -->
1220 <!-- OBJECT METHODS -->
1221 <!-- OBJECT EVENT FIELDS -->
1222 <!-- FUNCTION PARAMETERS -->
1223 </div>
1224 </div><div>
1225 <div>
1226 <dt>
1227 <var>scriptCache</var>
1228 <em>
1229 <!-- TYPE -->
1230 <div style="display:inline">
1231 (
1232 <span class="optional">optional</span>
1233 <span id="typeTemplate">
1234 <span>
1235 <a href="experimental.processes.html#type-Cache">Cache</ a>
1236 </span>
1237 </span>
1238 )
1239 </div>
1240 </em>
1241 </dt>
1242 <dd>The most recent information about the script cache for the process . Only available when receiving the object as part of a callback from onUpdated or onUpdatedWithMemory.</dd>
1243 <!-- OBJECT PROPERTIES -->
1244 <!-- OBJECT METHODS -->
1245 <!-- OBJECT EVENT FIELDS -->
1246 <!-- FUNCTION PARAMETERS -->
1247 </div>
1248 </div><div>
1249 <div>
1250 <dt>
1251 <var>cssCache</var>
1252 <em>
1253 <!-- TYPE -->
1254 <div style="display:inline">
1255 (
1256 <span class="optional">optional</span>
1257 <span id="typeTemplate">
1258 <span>
1259 <a href="experimental.processes.html#type-Cache">Cache</ a>
1260 </span>
1261 </span>
1262 )
1263 </div>
1264 </em>
1265 </dt>
1266 <dd>The most recent information about the CSS cache for the process. O nly available when receiving the object as part of a callback from onUpdated or onUpdatedWithMemory.</dd>
1267 <!-- OBJECT PROPERTIES -->
1268 <!-- OBJECT METHODS -->
1269 <!-- OBJECT EVENT FIELDS -->
1270 <!-- FUNCTION PARAMETERS -->
1271 </div>
1272 </div>
1273 </dl>
1274 </dd>
1275 <!-- OBJECT METHODS -->
1276 <!-- OBJECT EVENT FIELDS -->
1277 <!-- FUNCTION PARAMETERS -->
1278 </div>
1279 </div><div class="apiItem">
1280 <a name="type-Cache"></a>
1281 <h4>Cache</h4>
1282 <div>
1283 <dt>
1284 <em>
1285 <!-- TYPE -->
1286 <div style="display:inline">
1287 (
1288 <span id="typeTemplate">
1289 <span>
1290 <span>object</span>
1291 </span>
1292 </span>
1293 )
1294 </div>
1295 </em>
1296 </dt>
1297 <dd>The Cache object contains information about the size and utilizati on of a cache used by the browser.</dd>
1298 <!-- OBJECT PROPERTIES -->
1299 <dd>
1300 <dl>
1301 <div>
1302 <div>
1303 <dt>
1304 <var>size</var>
1305 <em>
1306 <!-- TYPE -->
1307 <div style="display:inline">
1308 (
1309 <span id="typeTemplate">
1310 <span>
1311 <span>number</span>
1312 </span>
1313 </span>
1314 )
1315 </div>
1316 </em>
1317 </dt>
1318 <dd>The size of the cache, in bytes.</dd>
1319 <!-- OBJECT PROPERTIES -->
1320 <!-- OBJECT METHODS -->
1321 <!-- OBJECT EVENT FIELDS -->
1322 <!-- FUNCTION PARAMETERS -->
1323 </div>
1324 </div><div>
1325 <div>
1326 <dt>
1327 <var>liveSize</var>
1328 <em>
1329 <!-- TYPE -->
1330 <div style="display:inline">
1331 (
1332 <span id="typeTemplate">
1333 <span>
1334 <span>number</span>
1335 </span>
1336 </span>
1337 )
1338 </div>
1339 </em>
1340 </dt>
1341 <dd>The part of the cache that is utilized, in bytes.</dd>
1342 <!-- OBJECT PROPERTIES -->
1343 <!-- OBJECT METHODS -->
1344 <!-- OBJECT EVENT FIELDS -->
1345 <!-- FUNCTION PARAMETERS -->
1346 </div>
1347 </div>
1348 </dl>
1349 </dd>
1350 <!-- OBJECT METHODS -->
1351 <!-- OBJECT EVENT FIELDS -->
1352 <!-- FUNCTION PARAMETERS -->
1353 </div>
1354 </div> <!-- /apiItem -->
1355 </div> <!-- /apiGroup -->
1356 </div> <!-- /apiPage -->
1357 </div> <!-- /gc-pagecontent -->
1358 </div> <!-- /g-section -->
1359 </div> <!-- /codesiteContent -->
1360 <div id="gc-footer" --="">
1361 <div class="text">
1362 <p>
1363 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1364 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1365 Attribution 3.0 License</a>, and code samples are licensed under the
1366 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1367 </p>
1368 <p>
1369 ©2011 Google
1370 </p>
1371 <!-- begin analytics -->
1372 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
1373 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
1374 <script type="text/javascript">
1375 // chrome doc tracking
1376 try {
1377 var engdocs = _gat._getTracker("YT-10763712-2");
1378 engdocs._trackPageview();
1379 } catch(err) {}
1380 // code.google.com site-wide tracking
1381 try {
1382 _uacct="UA-18071-1";
1383 _uanchor=1;
1384 _uff=0;
1385 urchinTracker();
1386 }
1387 catch(e) {/* urchinTracker not available. */}
1388 </script>
1389 <!-- end analytics -->
1390 </div>
1391 </div> <!-- /gc-footer -->
1392 </div> <!-- /gc-container -->
1393 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.privacy.html ('k') | chrome/common/extensions/docs/experimental.record.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698