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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10175008: Improving the process model extension API (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Schema file synced with docs, some minor cleanup. Created 8 years, 7 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
« chrome/browser/extensions/extension_tab_util.cc ('K') | « chrome/common/extensions/docs/examples/api/processes/process_monitor/popup.js ('k') | chrome/common/extensions/docs/samples.html » ('j') | chrome/test/data/extensions/api_test/processes/api/test.js » ('J')
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 class="todo">
292 Undocumented.
293 </dd>
294 <!-- OBJECT PROPERTIES -->
295 <!-- OBJECT METHODS -->
296 <!-- OBJECT EVENT FIELDS -->
297 <!-- FUNCTION PARAMETERS -->
298 </div>
299 </div><div>
300 <div>
301 <dt>
302 <var>callback</var>
303 <em>
304 <!-- TYPE -->
305 <div style="display:inline">
306 (
307 <span id="typeTemplate">
308 <span>
309 <span>function</span>
310 </span>
311 </span>
312 )
313 </div>
314 </em>
315 </dt>
316 <dd class="todo">
317 Undocumented.
318 </dd>
319 <!-- OBJECT PROPERTIES -->
320 <!-- OBJECT METHODS -->
321 <!-- OBJECT EVENT FIELDS -->
322 <!-- FUNCTION PARAMETERS -->
323 </div>
324 </div>
325 </dl>
326 <!-- RETURNS -->
327 <dl>
328 </dl>
329 <!-- CALLBACK -->
330 <div>
331 <div>
332 <h4>Callback function</h4>
333 <p>
334 The callback <em>parameter</em> should specify a function
335 that looks like this:
336 </p>
337 <!-- Note: intentionally longer 80 columns -->
338 <pre>function(<span>integer processId</span>) <span class="sub dued">{...}</span>;</pre>
339 <dl>
340 <div>
341 <div>
342 <dt>
343 <var>processId</var>
344 <em>
345 <!-- TYPE -->
346 <div style="display:inline">
347 (
348 <span id="typeTemplate">
349 <span>
350 <span>integer</span>
351 </span>
352 </span>
353 )
354 </div>
355 </em>
356 </dt>
357 <dd>Process ID of the tab's renderer process.</dd>
358 <!-- OBJECT PROPERTIES -->
359 <!-- OBJECT METHODS -->
360 <!-- OBJECT EVENT FIELDS -->
361 <!-- FUNCTION PARAMETERS -->
362 </div>
363 </div>
364 </dl>
365 </div>
366 </div>
367 <!-- MIN_VERSION -->
368 </div> <!-- /description -->
369 </div><div class="apiItem">
370 <a name="method-getProcessInfo"></a> <!-- method-anchor -->
371 <h4>getProcessInfo</h4>
372 <div class="summary">
373 <!-- Note: intentionally longer 80 columns -->
374 <span>chrome.experimental.processes.getProcessInfo</span>(<spa n class="null"><span>integer or array of integer</span>
375 <var><span>processIds</span></var></span><span class="null "><span>, </span><span>boolean</span>
376 <var><span>includeMemory</span></var></span><span class="n ull"><span>, </span><span>function</span>
377 <var><span>callback</span></var></span>)</div>
378 <div class="description">
379 <p>Retrieves the process information for each process ID specifi ed.</p>
380 <!-- PARAMETERS -->
381 <h4>Parameters</h4>
382 <dl>
383 <div>
384 <div>
385 <dt>
386 <var>processIds</var>
387 <em>
388 <!-- TYPE -->
389 <div style="display:inline">
390 (
391 <span id="typeTemplate">
392 <span>
393 <span>integer or array of integer</span>
394 </span>
395 </span>
396 )
397 </div>
398 </em>
399 </dt>
400 <dd class="todo">
401 Undocumented.
402 </dd>
403 <!-- OBJECT PROPERTIES -->
404 <!-- OBJECT METHODS -->
405 <!-- OBJECT EVENT FIELDS -->
406 <!-- FUNCTION PARAMETERS -->
407 </div>
408 </div><div>
409 <div>
410 <dt>
411 <var>includeMemory</var>
412 <em>
413 <!-- TYPE -->
414 <div style="display:inline">
415 (
416 <span id="typeTemplate">
417 <span>
418 <span>boolean</span>
419 </span>
420 </span>
421 )
422 </div>
423 </em>
424 </dt>
425 <dd class="todo">
426 Undocumented.
427 </dd>
428 <!-- OBJECT PROPERTIES -->
429 <!-- OBJECT METHODS -->
430 <!-- OBJECT EVENT FIELDS -->
431 <!-- FUNCTION PARAMETERS -->
432 </div>
433 </div><div>
434 <div>
435 <dt>
436 <var>callback</var>
437 <em>
438 <!-- TYPE -->
439 <div style="display:inline">
440 (
441 <span id="typeTemplate">
442 <span>
443 <span>function</span>
444 </span>
445 </span>
446 )
447 </div>
448 </em>
449 </dt>
450 <dd class="todo">
451 Undocumented.
452 </dd>
453 <!-- OBJECT PROPERTIES -->
454 <!-- OBJECT METHODS -->
455 <!-- OBJECT EVENT FIELDS -->
456 <!-- FUNCTION PARAMETERS -->
457 </div>
458 </div>
459 </dl>
460 <!-- RETURNS -->
461 <dl>
462 </dl>
463 <!-- CALLBACK -->
464 <div>
465 <div>
466 <h4>Callback function</h4>
467 <p>
468 The callback <em>parameter</em> should specify a function
469 that looks like this:
470 </p>
471 <!-- Note: intentionally longer 80 columns -->
472 <pre>function(<span>object processes</span>) <span class="subd ued">{...}</span>;</pre>
473 <dl>
474 <div>
475 <div>
476 <dt>
477 <var>processes</var>
478 <em>
479 <!-- TYPE -->
480 <div style="display:inline">
481 (
482 <span id="typeTemplate">
483 <span>
484 <span>object</span>
485 </span>
486 </span>
487 )
488 </div>
489 </em>
490 </dt>
491 <dd class="todo">
492 Undocumented.
493 </dd>
494 <!-- OBJECT PROPERTIES -->
495 <!-- OBJECT METHODS -->
496 <!-- OBJECT EVENT FIELDS -->
497 <!-- FUNCTION PARAMETERS -->
498 </div>
499 </div>
500 </dl>
501 </div>
502 </div>
503 <!-- MIN_VERSION -->
504 </div> <!-- /description -->
505 </div><div class="apiItem">
506 <a name="method-terminate"></a> <!-- method-anchor -->
507 <h4>terminate</h4>
508 <div class="summary">
509 <!-- Note: intentionally longer 80 columns -->
510 <span>chrome.experimental.processes.terminate</span>(<span cla ss="null"><span>integer</span>
511 <var><span>processId</span></var></span><span class="optio nal"><span>, </span><span>function</span>
512 <var><span>callback</span></var></span>)</div>
513 <div class="description">
514 <p>Terminates the specified renderer process. Equivalent to visi ting about:crash, but without changing the tab's URL.</p>
515 <!-- PARAMETERS -->
516 <h4>Parameters</h4>
517 <dl>
518 <div>
519 <div>
520 <dt>
521 <var>processId</var>
522 <em>
523 <!-- TYPE -->
524 <div style="display:inline">
525 (
526 <span id="typeTemplate">
527 <span>
528 <span>integer</span>
529 </span>
530 </span>
531 )
532 </div>
533 </em>
534 </dt>
535 <dd class="todo">
536 Undocumented.
537 </dd>
538 <!-- OBJECT PROPERTIES -->
539 <!-- OBJECT METHODS -->
540 <!-- OBJECT EVENT FIELDS -->
541 <!-- FUNCTION PARAMETERS -->
542 </div>
543 </div><div>
544 <div>
545 <dt>
546 <var>callback</var>
547 <em>
548 <!-- TYPE -->
549 <div style="display:inline">
550 (
551 <span class="optional">optional</span>
552 <span id="typeTemplate">
553 <span>
554 <span>function</span>
555 </span>
556 </span>
557 )
558 </div>
559 </em>
560 </dt>
561 <dd class="todo">
562 Undocumented.
563 </dd>
564 <!-- OBJECT PROPERTIES -->
565 <!-- OBJECT METHODS -->
566 <!-- OBJECT EVENT FIELDS -->
567 <!-- FUNCTION PARAMETERS -->
568 </div>
569 </div>
570 </dl>
571 <!-- RETURNS -->
572 <dl>
573 </dl>
574 <!-- CALLBACK -->
575 <div>
576 <div>
577 <h4>Callback function</h4>
578 <p>
579 If you specify the <em>callback</em> parameter, it should
580 specify a function that looks like this:
581 </p>
582 <!-- Note: intentionally longer 80 columns -->
583 <pre>function(<span>boolean didTerminate</span>) <span class=" subdued">{...}</span>;</pre>
584 <dl>
585 <div>
586 <div>
587 <dt>
588 <var>didTerminate</var>
589 <em>
590 <!-- TYPE -->
591 <div style="display:inline">
592 (
593 <span id="typeTemplate">
594 <span>
595 <span>boolean</span>
596 </span>
597 </span>
598 )
599 </div>
600 </em>
601 </dt>
602 <dd>True if the process was successfully killed.</dd>
603 <!-- OBJECT PROPERTIES -->
604 <!-- OBJECT METHODS -->
605 <!-- OBJECT EVENT FIELDS -->
606 <!-- FUNCTION PARAMETERS -->
607 </div>
608 </div>
609 </dl>
610 </div>
611 </div>
612 <!-- MIN_VERSION -->
613 </div> <!-- /description -->
614 </div> <!-- /apiItem -->
615 </div> <!-- /apiGroup -->
616 <!-- EVENTS -->
617 <div id="eventsTemplate" class="apiGroup">
618 <a name="global-events"></a>
619 <h3>Events</h3>
620 <!-- iterates over all events -->
621 <div class="apiItem">
622 <a name="event-onCreated"></a>
623 <h4>onCreated</h4>
624 <div class="summary">
625 <!-- Note: intentionally longer 80 columns -->
626 <span class="subdued">chrome.experimental.processes.</span><span >onCreated</span><span class="subdued">.addListener</span>(function(<span>intege r processId, Process process</span>) <span class="subdued">{...}</span><span></s pan>);
627 </div>
628 <div class="description">
629 <p>Fired each time a process is created, providing the corrsepon ding Process object.</p>
630 <!-- LISTENER PARAMETERS -->
631 <div>
632 <h4>Listener parameters</h4>
633 <dl>
634 <div>
635 <div>
636 <dt>
637 <var>processId</var>
638 <em>
639 <!-- TYPE -->
640 <div style="display:inline">
641 (
642 <span id="typeTemplate">
643 <span>
644 <span>integer</span>
645 </span>
646 </span>
647 )
648 </div>
649 </em>
650 </dt>
651 <dd class="todo">
652 Undocumented.
653 </dd>
654 <!-- OBJECT PROPERTIES -->
655 <!-- OBJECT METHODS -->
656 <!-- OBJECT EVENT FIELDS -->
657 <!-- FUNCTION PARAMETERS -->
658 </div>
659 </div><div>
660 <div>
661 <dt>
662 <var>process</var>
663 <em>
664 <!-- TYPE -->
665 <div style="display:inline">
666 (
667 <span id="typeTemplate">
668 <span>
669 <a href="experimental.processes.html#type-Process">Proce ss</a>
670 </span>
671 </span>
672 )
673 </div>
674 </em>
675 </dt>
676 <dd class="todo">
677 Undocumented.
678 </dd>
679 <!-- OBJECT PROPERTIES -->
680 <!-- OBJECT METHODS -->
681 <!-- OBJECT EVENT FIELDS -->
682 <!-- FUNCTION PARAMETERS -->
683 </div>
684 </div>
685 </dl>
686 </div>
687 <!-- EXTRA PARAMETERS -->
688 <!-- LISTENER RETURN VALUE -->
689 <dl>
690 </dl>
691 </div> <!-- /description -->
692 </div><div class="apiItem">
693 <a name="event-onExited"></a>
694 <h4>onExited</h4>
695 <div class="summary">
696 <!-- Note: intentionally longer 80 columns -->
697 <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>);
698 </div>
699 <div class="description">
700 <p>Fired each time a process is terminated, providing the type o f exit.</p>
701 <!-- LISTENER PARAMETERS -->
702 <div>
703 <h4>Listener parameters</h4>
704 <dl>
705 <div>
706 <div>
707 <dt>
708 <var>processId</var>
709 <em>
710 <!-- TYPE -->
711 <div style="display:inline">
712 (
713 <span id="typeTemplate">
714 <span>
715 <span>integer</span>
716 </span>
717 </span>
718 )
719 </div>
720 </em>
721 </dt>
722 <dd class="todo">
723 Undocumented.
724 </dd>
725 <!-- OBJECT PROPERTIES -->
726 <!-- OBJECT METHODS -->
727 <!-- OBJECT EVENT FIELDS -->
728 <!-- FUNCTION PARAMETERS -->
729 </div>
730 </div><div>
731 <div>
732 <dt>
733 <var>exitType</var>
734 <em>
735 <!-- TYPE -->
736 <div style="display:inline">
737 (
738 <span id="typeTemplate">
739 <span>
740 <span>integer</span>
741 </span>
742 </span>
743 )
744 </div>
745 </em>
746 </dt>
747 <dd class="todo">
748 Undocumented.
749 </dd>
750 <!-- OBJECT PROPERTIES -->
751 <!-- OBJECT METHODS -->
752 <!-- OBJECT EVENT FIELDS -->
753 <!-- FUNCTION PARAMETERS -->
754 </div>
755 </div><div>
756 <div>
757 <dt>
758 <var>exitCode</var>
759 <em>
760 <!-- TYPE -->
761 <div style="display:inline">
762 (
763 <span id="typeTemplate">
764 <span>
765 <span>integer</span>
766 </span>
767 </span>
768 )
769 </div>
770 </em>
771 </dt>
772 <dd class="todo">
773 Undocumented.
774 </dd>
775 <!-- OBJECT PROPERTIES -->
776 <!-- OBJECT METHODS -->
777 <!-- OBJECT EVENT FIELDS -->
778 <!-- FUNCTION PARAMETERS -->
779 </div>
780 </div>
781 </dl>
782 </div>
783 <!-- EXTRA PARAMETERS -->
784 <!-- LISTENER RETURN VALUE -->
785 <dl>
786 </dl>
787 </div> <!-- /description -->
788 </div><div class="apiItem">
789 <a name="event-onUnresponsive"></a>
790 <h4>onUnresponsive</h4>
791 <div class="summary">
792 <!-- Note: intentionally longer 80 columns -->
793 <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>);
794 </div>
795 <div class="description">
796 <p>Fired each time a process becomes unresponsive, providing the corrseponding Process object.</p>
797 <!-- LISTENER PARAMETERS -->
798 <div>
799 <h4>Listener parameters</h4>
800 <dl>
801 <div>
802 <div>
803 <dt>
804 <var>process</var>
805 <em>
806 <!-- TYPE -->
807 <div style="display:inline">
808 (
809 <span id="typeTemplate">
810 <span>
811 <a href="experimental.processes.html#type-Process">Proce ss</a>
812 </span>
813 </span>
814 )
815 </div>
816 </em>
817 </dt>
818 <dd class="todo">
819 Undocumented.
820 </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 </div><div class="apiItem">
835 <a name="event-onUpdated"></a>
836 <h4>onUpdated</h4>
837 <div class="summary">
838 <!-- Note: intentionally longer 80 columns -->
839 <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>);
840 </div>
841 <div class="description">
842 <p>Fired each time the Task Manager updates its process statisti cs, providing the dictionary of updated Process objects, indexed by process ID.< /p>
843 <!-- LISTENER PARAMETERS -->
844 <div>
845 <h4>Listener parameters</h4>
846 <dl>
847 <div>
848 <div>
849 <dt>
850 <var>processes</var>
851 <em>
852 <!-- TYPE -->
853 <div style="display:inline">
854 (
855 <span id="typeTemplate">
856 <span>
857 <span>object</span>
858 </span>
859 </span>
860 )
861 </div>
862 </em>
863 </dt>
864 <dd class="todo">
865 Undocumented.
866 </dd>
867 <!-- OBJECT PROPERTIES -->
868 <!-- OBJECT METHODS -->
869 <!-- OBJECT EVENT FIELDS -->
870 <!-- FUNCTION PARAMETERS -->
871 </div>
872 </div>
873 </dl>
874 </div>
875 <!-- EXTRA PARAMETERS -->
876 <!-- LISTENER RETURN VALUE -->
877 <dl>
878 </dl>
879 </div> <!-- /description -->
880 </div><div class="apiItem">
881 <a name="event-onUpdatedWithMemory"></a>
882 <h4>onUpdatedWithMemory</h4>
883 <div class="summary">
884 <!-- Note: intentionally longer 80 columns -->
885 <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>);
886 </div>
887 <div class="description">
888 <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>
889 <!-- LISTENER PARAMETERS -->
890 <div>
891 <h4>Listener parameters</h4>
892 <dl>
893 <div>
894 <div>
895 <dt>
896 <var>processes</var>
897 <em>
898 <!-- TYPE -->
899 <div style="display:inline">
900 (
901 <span id="typeTemplate">
902 <span>
903 <span>object</span>
904 </span>
905 </span>
906 )
907 </div>
908 </em>
909 </dt>
910 <dd class="todo">
911 Undocumented.
912 </dd>
913 <!-- OBJECT PROPERTIES -->
914 <!-- OBJECT METHODS -->
915 <!-- OBJECT EVENT FIELDS -->
916 <!-- FUNCTION PARAMETERS -->
917 </div>
918 </div>
919 </dl>
920 </div>
921 <!-- EXTRA PARAMETERS -->
922 <!-- LISTENER RETURN VALUE -->
923 <dl>
924 </dl>
925 </div> <!-- /description -->
926 </div> <!-- /apiItem -->
927 </div> <!-- /apiGroup -->
928 <!-- TYPES -->
929 <div class="apiGroup">
930 <a name="types"></a>
931 <h3 id="types">Types</h3>
932 <!-- iterates over all types -->
933 <div class="apiItem">
934 <a name="type-Process"></a>
935 <h4>Process</h4>
936 <div>
937 <dt>
938 <em>
939 <!-- TYPE -->
940 <div style="display:inline">
941 (
942 <span id="typeTemplate">
943 <span>
944 <span>object</span>
945 </span>
946 </span>
947 )
948 </div>
949 </em>
950 </dt>
951 <dd>An object containing information about one of the browser's proces ses.</dd>
952 <!-- OBJECT PROPERTIES -->
953 <dd>
954 <dl>
955 <div>
956 <div>
957 <dt>
958 <var>id</var>
959 <em>
960 <!-- TYPE -->
961 <div style="display:inline">
962 (
963 <span id="typeTemplate">
964 <span>
965 <span>integer</span>
966 </span>
967 </span>
968 )
969 </div>
970 </em>
971 </dt>
972 <dd>Unique ID of the process provided by Chrome.</dd>
973 <!-- OBJECT PROPERTIES -->
974 <!-- OBJECT METHODS -->
975 <!-- OBJECT EVENT FIELDS -->
976 <!-- FUNCTION PARAMETERS -->
977 </div>
978 </div><div>
979 <div>
980 <dt>
981 <var>osProcessId</var>
982 <em>
983 <!-- TYPE -->
984 <div style="display:inline">
985 (
986 <span id="typeTemplate">
987 <span>
988 <span>integer</span>
989 </span>
990 </span>
991 )
992 </div>
993 </em>
994 </dt>
995 <dd>The ID of the process, as provided by the OS.</dd>
996 <!-- OBJECT PROPERTIES -->
997 <!-- OBJECT METHODS -->
998 <!-- OBJECT EVENT FIELDS -->
999 <!-- FUNCTION PARAMETERS -->
1000 </div>
1001 </div><div>
1002 <div>
1003 <dt>
1004 <var>type</var>
1005 <em>
1006 <!-- TYPE -->
1007 <div style="display:inline">
1008 (
1009 <span class="enum">enumerated</span>
1010 <span id="typeTemplate">
1011 <span>
1012 <span>string</span>
1013 <span>["browser", "renderer", "extension", "notification ", "plugin", "worker", "nacl", "utility", "gpu", "other"]</span>
1014 </span>
1015 </span>
1016 )
1017 </div>
1018 </em>
1019 </dt>
1020 <dd>The type of process.</dd>
1021 <!-- OBJECT PROPERTIES -->
1022 <!-- OBJECT METHODS -->
1023 <!-- OBJECT EVENT FIELDS -->
1024 <!-- FUNCTION PARAMETERS -->
1025 </div>
1026 </div><div>
1027 <div>
1028 <dt>
1029 <var>profile</var>
1030 <em>
1031 <!-- TYPE -->
1032 <div style="display:inline">
1033 (
1034 <span id="typeTemplate">
1035 <span>
1036 <span>string</span>
1037 </span>
1038 </span>
1039 )
1040 </div>
1041 </em>
1042 </dt>
1043 <dd>The profile which the process is associated with.</dd>
1044 <!-- OBJECT PROPERTIES -->
1045 <!-- OBJECT METHODS -->
1046 <!-- OBJECT EVENT FIELDS -->
1047 <!-- FUNCTION PARAMETERS -->
1048 </div>
1049 </div><div>
1050 <div>
1051 <dt>
1052 <var>tabs</var>
1053 <em>
1054 <!-- TYPE -->
1055 <div style="display:inline">
1056 (
1057 <span id="typeTemplate">
1058 <span>
1059 <span>
1060 array of <span><span>
1061 <span>
1062 <span>integer</span>
1063 </span>
1064 </span></span>
1065 </span>
1066 </span>
1067 </span>
1068 )
1069 </div>
1070 </em>
1071 </dt>
1072 <dd>Array of Tab IDs that have a page rendered by this process (for re nderer processes only).</dd>
1073 <!-- OBJECT PROPERTIES -->
1074 <!-- OBJECT METHODS -->
1075 <!-- OBJECT EVENT FIELDS -->
1076 <!-- FUNCTION PARAMETERS -->
1077 </div>
1078 </div><div>
1079 <div>
1080 <dt>
1081 <var>cpu</var>
1082 <em>
1083 <!-- TYPE -->
1084 <div style="display:inline">
1085 (
1086 <span class="optional">optional</span>
1087 <span id="typeTemplate">
1088 <span>
1089 <span>number</span>
1090 </span>
1091 </span>
1092 )
1093 </div>
1094 </em>
1095 </dt>
1096 <dd>The most recent measurement of the process CPU usage, between 0 an d 100%.</dd>
1097 <!-- OBJECT PROPERTIES -->
1098 <!-- OBJECT METHODS -->
1099 <!-- OBJECT EVENT FIELDS -->
1100 <!-- FUNCTION PARAMETERS -->
1101 </div>
1102 </div><div>
1103 <div>
1104 <dt>
1105 <var>network</var>
1106 <em>
1107 <!-- TYPE -->
1108 <div style="display:inline">
1109 (
1110 <span class="optional">optional</span>
1111 <span id="typeTemplate">
1112 <span>
1113 <span>number</span>
1114 </span>
1115 </span>
1116 )
1117 </div>
1118 </em>
1119 </dt>
1120 <dd>The most recent measurement of the process network usage, in bytes per second.</dd>
1121 <!-- OBJECT PROPERTIES -->
1122 <!-- OBJECT METHODS -->
1123 <!-- OBJECT EVENT FIELDS -->
1124 <!-- FUNCTION PARAMETERS -->
1125 </div>
1126 </div><div>
1127 <div>
1128 <dt>
1129 <var>privateMemory</var>
1130 <em>
1131 <!-- TYPE -->
1132 <div style="display:inline">
1133 (
1134 <span class="optional">optional</span>
1135 <span id="typeTemplate">
1136 <span>
1137 <span>number</span>
1138 </span>
1139 </span>
1140 )
1141 </div>
1142 </em>
1143 </dt>
1144 <dd>The most recent measurement of the process private memory usage, i n bytes.</dd>
1145 <!-- OBJECT PROPERTIES -->
1146 <!-- OBJECT METHODS -->
1147 <!-- OBJECT EVENT FIELDS -->
1148 <!-- FUNCTION PARAMETERS -->
1149 </div>
1150 </div><div>
1151 <div>
1152 <dt>
1153 <var>memoryUsage</var>
1154 <em>
1155 <!-- TYPE -->
1156 <div style="display:inline">
1157 (
1158 <span class="optional">optional</span>
1159 <span id="typeTemplate">
1160 <span>
1161 <a>MemoryUsage</a>
1162 </span>
1163 </span>
1164 )
1165 </div>
1166 </em>
1167 </dt>
1168 <dd>Object containing the most recent details about process memory usa ge, in bytes.</dd>
1169 <!-- OBJECT PROPERTIES -->
1170 <!-- OBJECT METHODS -->
1171 <!-- OBJECT EVENT FIELDS -->
1172 <!-- FUNCTION PARAMETERS -->
1173 </div>
1174 </div><div>
1175 <div>
1176 <dt>
1177 <var>jsMemoryAllocated</var>
1178 <em>
1179 <!-- TYPE -->
1180 <div style="display:inline">
1181 (
1182 <span class="optional">optional</span>
1183 <span id="typeTemplate">
1184 <span>
1185 <span>number</span>
1186 </span>
1187 </span>
1188 )
1189 </div>
1190 </em>
1191 </dt>
1192 <dd>The most recent measurement of the process JavaScript allocated me mory, in bytes.</dd>
1193 <!-- OBJECT PROPERTIES -->
1194 <!-- OBJECT METHODS -->
1195 <!-- OBJECT EVENT FIELDS -->
1196 <!-- FUNCTION PARAMETERS -->
1197 </div>
1198 </div><div>
1199 <div>
1200 <dt>
1201 <var>jsMemoryUsed</var>
1202 <em>
1203 <!-- TYPE -->
1204 <div style="display:inline">
1205 (
1206 <span class="optional">optional</span>
1207 <span id="typeTemplate">
1208 <span>
1209 <span>number</span>
1210 </span>
1211 </span>
1212 )
1213 </div>
1214 </em>
1215 </dt>
1216 <dd>The most recent measurement of the process JavaScript memory used, in bytes.</dd>
1217 <!-- OBJECT PROPERTIES -->
1218 <!-- OBJECT METHODS -->
1219 <!-- OBJECT EVENT FIELDS -->
1220 <!-- FUNCTION PARAMETERS -->
1221 </div>
1222 </div><div>
1223 <div>
1224 <dt>
1225 <var>sqliteMemory</var>
1226 <em>
1227 <!-- TYPE -->
1228 <div style="display:inline">
1229 (
1230 <span class="optional">optional</span>
1231 <span id="typeTemplate">
1232 <span>
1233 <span>number</span>
1234 </span>
1235 </span>
1236 )
1237 </div>
1238 </em>
1239 </dt>
1240 <dd>The most recent measurement of the process’s SQLite memory usage, in bytes.</dd>
1241 <!-- OBJECT PROPERTIES -->
1242 <!-- OBJECT METHODS -->
1243 <!-- OBJECT EVENT FIELDS -->
1244 <!-- FUNCTION PARAMETERS -->
1245 </div>
1246 </div><div>
1247 <div>
1248 <dt>
1249 <var>fps</var>
1250 <em>
1251 <!-- TYPE -->
1252 <div style="display:inline">
1253 (
1254 <span class="optional">optional</span>
1255 <span id="typeTemplate">
1256 <span>
1257 <span>number</span>
1258 </span>
1259 </span>
1260 )
1261 </div>
1262 </em>
1263 </dt>
1264 <dd>The most recent measurement of the process frames per second.</dd>
1265 <!-- OBJECT PROPERTIES -->
1266 <!-- OBJECT METHODS -->
1267 <!-- OBJECT EVENT FIELDS -->
1268 <!-- FUNCTION PARAMETERS -->
1269 </div>
1270 </div><div>
1271 <div>
1272 <dt>
1273 <var>imageCache</var>
1274 <em>
1275 <!-- TYPE -->
1276 <div style="display:inline">
1277 (
1278 <span class="optional">optional</span>
1279 <span id="typeTemplate">
1280 <span>
1281 <a href="experimental.processes.html#type-Cache">Cache</ a>
1282 </span>
1283 </span>
1284 )
1285 </div>
1286 </em>
1287 </dt>
1288 <dd>The most recent information about the image cache for the process. </dd>
1289 <!-- OBJECT PROPERTIES -->
1290 <!-- OBJECT METHODS -->
1291 <!-- OBJECT EVENT FIELDS -->
1292 <!-- FUNCTION PARAMETERS -->
1293 </div>
1294 </div><div>
1295 <div>
1296 <dt>
1297 <var>scriptCache</var>
1298 <em>
1299 <!-- TYPE -->
1300 <div style="display:inline">
1301 (
1302 <span class="optional">optional</span>
1303 <span id="typeTemplate">
1304 <span>
1305 <a href="experimental.processes.html#type-Cache">Cache</ a>
1306 </span>
1307 </span>
1308 )
1309 </div>
1310 </em>
1311 </dt>
1312 <dd>The most recent information about the script cache for the process .</dd>
1313 <!-- OBJECT PROPERTIES -->
1314 <!-- OBJECT METHODS -->
1315 <!-- OBJECT EVENT FIELDS -->
1316 <!-- FUNCTION PARAMETERS -->
1317 </div>
1318 </div><div>
1319 <div>
1320 <dt>
1321 <var>cssCache</var>
1322 <em>
1323 <!-- TYPE -->
1324 <div style="display:inline">
1325 (
1326 <span class="optional">optional</span>
1327 <span id="typeTemplate">
1328 <span>
1329 <a href="experimental.processes.html#type-Cache">Cache</ a>
1330 </span>
1331 </span>
1332 )
1333 </div>
1334 </em>
1335 </dt>
1336 <dd>The most recent information about the CSS cache for the process.</ dd>
1337 <!-- OBJECT PROPERTIES -->
1338 <!-- OBJECT METHODS -->
1339 <!-- OBJECT EVENT FIELDS -->
1340 <!-- FUNCTION PARAMETERS -->
1341 </div>
1342 </div>
1343 </dl>
1344 </dd>
1345 <!-- OBJECT METHODS -->
1346 <!-- OBJECT EVENT FIELDS -->
1347 <!-- FUNCTION PARAMETERS -->
1348 </div>
1349 </div><div class="apiItem">
1350 <a name="type-Cache"></a>
1351 <h4>Cache</h4>
1352 <div>
1353 <dt>
1354 <em>
1355 <!-- TYPE -->
1356 <div style="display:inline">
1357 (
1358 <span id="typeTemplate">
1359 <span>
1360 <span>object</span>
1361 </span>
1362 </span>
1363 )
1364 </div>
1365 </em>
1366 </dt>
1367 <dd>The Cache object contains information about the size and utilizati on of a cache used by Chromium.</dd>
1368 <!-- OBJECT PROPERTIES -->
1369 <dd>
1370 <dl>
1371 <div>
1372 <div>
1373 <dt>
1374 <var>size</var>
1375 <em>
1376 <!-- TYPE -->
1377 <div style="display:inline">
1378 (
1379 <span id="typeTemplate">
1380 <span>
1381 <span>number</span>
1382 </span>
1383 </span>
1384 )
1385 </div>
1386 </em>
1387 </dt>
1388 <dd>The size of the cache, in bytes.</dd>
1389 <!-- OBJECT PROPERTIES -->
1390 <!-- OBJECT METHODS -->
1391 <!-- OBJECT EVENT FIELDS -->
1392 <!-- FUNCTION PARAMETERS -->
1393 </div>
1394 </div><div>
1395 <div>
1396 <dt>
1397 <var>liveSize</var>
1398 <em>
1399 <!-- TYPE -->
1400 <div style="display:inline">
1401 (
1402 <span id="typeTemplate">
1403 <span>
1404 <span>number</span>
1405 </span>
1406 </span>
1407 )
1408 </div>
1409 </em>
1410 </dt>
1411 <dd>The part of the cache that is utilized, in bytes.</dd>
1412 <!-- OBJECT PROPERTIES -->
1413 <!-- OBJECT METHODS -->
1414 <!-- OBJECT EVENT FIELDS -->
1415 <!-- FUNCTION PARAMETERS -->
1416 </div>
1417 </div>
1418 </dl>
1419 </dd>
1420 <!-- OBJECT METHODS -->
1421 <!-- OBJECT EVENT FIELDS -->
1422 <!-- FUNCTION PARAMETERS -->
1423 </div>
1424 </div> <!-- /apiItem -->
1425 </div> <!-- /apiGroup -->
1426 </div> <!-- /apiPage -->
1427 </div> <!-- /gc-pagecontent -->
1428 </div> <!-- /g-section -->
1429 </div> <!-- /codesiteContent -->
1430 <div id="gc-footer" --="">
1431 <div class="text">
1432 <p>
1433 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1434 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1435 Attribution 3.0 License</a>, and code samples are licensed under the
1436 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1437 </p>
1438 <p>
1439 ©2011 Google
1440 </p>
1441 <!-- begin analytics -->
1442 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
1443 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
1444 <script type="text/javascript">
1445 // chrome doc tracking
1446 try {
1447 var engdocs = _gat._getTracker("YT-10763712-2");
1448 engdocs._trackPageview();
1449 } catch(err) {}
1450 // code.google.com site-wide tracking
1451 try {
1452 _uacct="UA-18071-1";
1453 _uanchor=1;
1454 _uff=0;
1455 urchinTracker();
1456 }
1457 catch(e) {/* urchinTracker not available. */}
1458 </script>
1459 <!-- end analytics -->
1460 </div>
1461 </div> <!-- /gc-footer -->
1462 </div> <!-- /gc-container -->
1463 </body></html>
OLDNEW
« chrome/browser/extensions/extension_tab_util.cc ('K') | « chrome/common/extensions/docs/examples/api/processes/process_monitor/popup.js ('k') | chrome/common/extensions/docs/samples.html » ('j') | chrome/test/data/extensions/api_test/processes/api/test.js » ('J')

Powered by Google App Engine
This is Rietveld 408576698