summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/experimental.processes.html
diff options
context:
space:
mode:
authorestade@chromium.org <estade@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2012-05-18 21:00:59 +0000
committerestade@chromium.org <estade@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2012-05-18 21:00:59 +0000
commite0ec52a6740850ff0c7e946667c2782f2c925550 (patch)
tree4e3b4a06021c86e5f64a95b207eeb60842020542 /chrome/common/extensions/docs/experimental.processes.html
parente022553060b02008791165078516c529859b762f (diff)
downloadchromium_src-e0ec52a6740850ff0c7e946667c2782f2c925550.zip
chromium_src-e0ec52a6740850ff0c7e946667c2782f2c925550.tar.gz
chromium_src-e0ec52a6740850ff0c7e946667c2782f2c925550.tar.bz2
redo r137692 and r137791 which were speculatively reverted
but turned out not to be causing breakage (although the former had caused some failures, the latter fixed it). convert chromeos file manager to loadTimeData BUG=122753 TEST=manual,unit change type of fileBrowserApi.getStrings it can get things that aren't necessarily strings. It's a dictionary of all types. BUG=none TEST=SelectFileDialogExtensionBrowserTest.OpenSingletonTabAndCancel and others on chromiumOS dbg Review URL: https://chromiumcodereview.appspot.com/10413011 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@137956 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common/extensions/docs/experimental.processes.html')
-rw-r--r--chrome/common/extensions/docs/experimental.processes.html136
1 files changed, 33 insertions, 103 deletions
diff --git a/chrome/common/extensions/docs/experimental.processes.html b/chrome/common/extensions/docs/experimental.processes.html
index d334cc6..394d3ec 100644
--- a/chrome/common/extensions/docs/experimental.processes.html
+++ b/chrome/common/extensions/docs/experimental.processes.html
@@ -288,9 +288,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>The ID of the tab for which the renderer process ID is to be returned.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -397,9 +395,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>The list of process IDs or single process ID for which to return the process information. An empty list indicates all processes are requested.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -422,9 +418,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>True if detailed memory usage is required. Note, collecting memory usage information incurs extra CPU usage and should only be queried for when needed.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -447,9 +441,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>Called when the processes information is collected.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -488,9 +480,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <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. Metrics requiring aggregation over time will not be populated in each Process object.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -532,9 +522,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>The ID of the process to be terminated.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -599,7 +587,7 @@
</div>
</em>
</dt>
- <dd>True if the process was successfully killed.</dd>
+ <dd>True if terminating the process was successful, otherwise false.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -623,7 +611,7 @@
<h4>onCreated</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.experimental.processes.</span><span>onCreated</span><span class="subdued">.addListener</span>(function(<span>integer processId, Process process</span>) <span class="subdued">{...}</span><span></span>);
+ <span class="subdued">chrome.experimental.processes.</span><span>onCreated</span><span class="subdued">.addListener</span>(function(<span>Process process</span>) <span class="subdued">{...}</span><span></span>);
</div>
<div class="description">
<p>Fired each time a process is created, providing the corrseponding Process object.</p>
@@ -634,31 +622,6 @@
<div>
<div>
<dt>
- <var>processId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
<var>process</var>
<em>
<!-- TYPE -->
@@ -673,9 +636,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>Details of the process that was created. Metrics requiring aggregation over time will not be populated in the object.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -689,6 +650,7 @@
<dl>
</dl>
</div> <!-- /description -->
+ <!-- /description -->
</div><div class="apiItem">
<a name="event-onExited"></a>
<h4>onExited</h4>
@@ -719,9 +681,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>The ID of the process that exited.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -744,9 +704,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>The type of exit that occurred for the process - normal, abnormal, killed, crashed. Only available for renderer processes.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -769,9 +727,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>The exit code if the process exited abnormally. Only available for renderer processes.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -785,6 +741,7 @@
<dl>
</dl>
</div> <!-- /description -->
+ <!-- /description -->
</div><div class="apiItem">
<a name="event-onUnresponsive"></a>
<h4>onUnresponsive</h4>
@@ -815,9 +772,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>Details of the unresponsive process. Metrics requiring aggregation over time will not be populated in the object. Only available for renderer processes.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -831,6 +786,7 @@
<dl>
</dl>
</div> <!-- /description -->
+ <!-- /description -->
</div><div class="apiItem">
<a name="event-onUpdated"></a>
<h4>onUpdated</h4>
@@ -861,9 +817,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>A dictionary of updated Process objects for each live process in the browser, indexed by process ID. Metrics requiring aggregation over time will be populated in each Process object.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -877,6 +831,7 @@
<dl>
</dl>
</div> <!-- /description -->
+ <!-- /description -->
</div><div class="apiItem">
<a name="event-onUpdatedWithMemory"></a>
<h4>onUpdatedWithMemory</h4>
@@ -907,9 +862,7 @@
</div>
</em>
</dt>
- <dd class="todo">
- Undocumented.
- </dd>
+ <dd>A dictionary of updated Process objects for each live process in the browser, indexed by process ID. Memory usage details will be included in each Process object.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -923,6 +876,7 @@
<dl>
</dl>
</div> <!-- /description -->
+ <!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- TYPES -->
@@ -969,7 +923,7 @@
</div>
</em>
</dt>
- <dd>Unique ID of the process provided by Chrome.</dd>
+ <dd>Unique ID of the process provided by the browser.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1069,7 +1023,7 @@
</div>
</em>
</dt>
- <dd>Array of Tab IDs that have a page rendered by this process (for renderer processes only).</dd>
+ <dd>Array of Tab IDs that have a page rendered by this process. The list will be non-empty for renderer processes only.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1093,7 +1047,7 @@
</div>
</em>
</dt>
- <dd>The most recent measurement of the process CPU usage, between 0 and 100%.</dd>
+ <dd>The most recent measurement of the process CPU usage, between 0 and 100%. Only available when receiving the object as part of a callback from onUpdated or onUpdatedWithMemory.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1117,7 +1071,7 @@
</div>
</em>
</dt>
- <dd>The most recent measurement of the process network usage, in bytes per second.</dd>
+ <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>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1141,31 +1095,7 @@
</div>
</em>
</dt>
- <dd>The most recent measurement of the process private memory usage, in bytes.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>memoryUsage</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a>MemoryUsage</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Object containing the most recent details about process memory usage, in bytes.</dd>
+ <dd>The most recent measurement of the process private memory usage, in bytes. Only available when receiving the object as part of a callback from onUpdatedWithMemory or getProcessInfo with the includeMemory flag.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1189,7 +1119,7 @@
</div>
</em>
</dt>
- <dd>The most recent measurement of the process JavaScript allocated memory, in bytes.</dd>
+ <dd>The most recent measurement of the process JavaScript allocated memory, in bytes. Only available when receiving the object as part of a callback from onUpdated or onUpdatedWithMemory.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1213,7 +1143,7 @@
</div>
</em>
</dt>
- <dd>The most recent measurement of the process JavaScript memory used, in bytes.</dd>
+ <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 onUpdated or onUpdatedWithMemory.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1237,7 +1167,7 @@
</div>
</em>
</dt>
- <dd>The most recent measurement of the process’s SQLite memory usage, in bytes.</dd>
+ <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 onUpdated or onUpdatedWithMemory.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1261,7 +1191,7 @@
</div>
</em>
</dt>
- <dd>The most recent measurement of the process frames per second.</dd>
+ <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 onUpdatedWithMemory.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1285,7 +1215,7 @@
</div>
</em>
</dt>
- <dd>The most recent information about the image cache for the process.</dd>
+ <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 or onUpdatedWithMemory.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1309,7 +1239,7 @@
</div>
</em>
</dt>
- <dd>The most recent information about the script cache for the process.</dd>
+ <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>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1333,7 +1263,7 @@
</div>
</em>
</dt>
- <dd>The most recent information about the CSS cache for the process.</dd>
+ <dd>The most recent information about the CSS cache for the process. Only available when receiving the object as part of a callback from onUpdated or onUpdatedWithMemory.</dd>
<!-- OBJECT PROPERTIES -->
<!-- OBJECT METHODS -->
<!-- OBJECT EVENT FIELDS -->
@@ -1364,7 +1294,7 @@
</div>
</em>
</dt>
- <dd>The Cache object contains information about the size and utilization of a cache used by Chromium.</dd>
+ <dd>The Cache object contains information about the size and utilization of a cache used by the browser.</dd>
<!-- OBJECT PROPERTIES -->
<dd>
<dl>