tools/telemetry/docs/pydoc/telemetry.core.platform.html - Issue 1647513002: Delete tools/telemetry.

Unified Diff: tools/telemetry/docs/pydoc/telemetry.core.platform.html

Issue 1647513002: Delete tools/telemetry. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: Created 4 years, 11 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 side-by-side diff with in-line comments

Download patch

« no previous file with comments | « tools/telemetry/docs/pydoc/telemetry.core.os_version.html ('k') | tools/telemetry/docs/pydoc/telemetry.core.profiling_controller.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/pydoc/telemetry.core.platform.html

diff --git a/tools/telemetry/docs/pydoc/telemetry.core.platform.html b/tools/telemetry/docs/pydoc/telemetry.core.platform.html

deleted file mode 100644

index 46f4e3868e2594b2e4fe33d8fa58eba66e6a3b9b..0000000000000000000000000000000000000000

--- a/tools/telemetry/docs/pydoc/telemetry.core.platform.html

+++ /dev/null

@@ -1,269 +0,0 @@

-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

-<html><head><title>Python: module telemetry.core.platform</title>

-<meta charset="utf-8">

-</head><body bgcolor="#f0f0f8">

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

-<tr bgcolor="#7799ee">

-<td valign=bottom>

-  <big><big><a href="telemetry.html">telemetry</a>.<a href="telemetry.core.html">core</a>.platform</big></big></td

-><td align=right valign=bottom

-><a href=".">index</a> <a href="../telemetry/core/platform.py">telemetry/core/platform.py</a></td></tr></table>

- <tt># Copyright 2012 The Chromium Authors. All rights reserved.

-# Use of this source code is governed by a BSD-style license that can be

-# found in the LICENSE file.</tt>

-

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#aa55cc">

-<td colspan=3 valign=bottom>

-<big>Modules</big></td></tr>

-<tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td>

-<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.discover.html">telemetry.core.discover</a>

-<a href="telemetry.core.local_server.html">telemetry.core.local_server</a>

-<a href="telemetry.core.memory_cache_http_server.html">telemetry.core.memory_cache_http_server</a>

-</td><td width="25%" valign=top><a href="telemetry.core.network_controller.html">telemetry.core.network_controller</a>

-<a href="os.html">os</a>

-<a href="telemetry.internal.platform.platform_backend.html">telemetry.internal.platform.platform_backend</a>

-</td><td width="25%" valign=top><a href="logging.html">logging</a>

-<a href="telemetry.core.tracing_controller.html">telemetry.core.tracing_controller</a>

-<a href="telemetry.core.util.html">telemetry.core.util</a>

-</td><td width="25%" valign=top></td></tr></table></td></tr></table>

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#ee77aa">

-<td colspan=3 valign=bottom>

-<big>Classes</big></td></tr>

-<tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td>

-<td width="100%"><dl>

-<dt><a href="__builtin__.html#object">__builtin__.object</a>

-</dt><dd>

-<dl>

-<dt><a href="telemetry.core.platform.html#Platform">Platform</a>

-</dt></dl>

-</dd>

-</dl>

-

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="Platform">class Platform</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

-<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

-<td colspan=2><tt>The platform that the target browser is running on.

-

-Provides a limited interface to interact with the platform itself, where

-possible. It's important to note that platforms may not provide a specific

-API, so check with IsFooBar() for availability.  </tt></td></tr>

-<tr><td> </td>

-<td width="100%">Methods defined here:

-<dl><dt><a name="Platform-CanCaptureVideo">CanCaptureVideo</a>(self)</dt><dd><tt>Returns a bool indicating whether the platform supports video capture.</tt></dd></dl>

-<dl><dt><a name="Platform-CanFlushIndividualFilesFromSystemCache">CanFlushIndividualFilesFromSystemCache</a>(self)</dt><dd><tt>Returns true if the disk cache can be flushed for specific files.</tt></dd></dl>

-<dl><dt><a name="Platform-CanLaunchApplication">CanLaunchApplication</a>(self, application)</dt><dd><tt>Returns whether the platform can launch the given application.</tt></dd></dl>

-<dl><dt><a name="Platform-CanMeasurePerApplicationPower">CanMeasurePerApplicationPower</a>(self)</dt><dd><tt>Returns True if the power monitor can measure power for the target

-application in isolation. False if power measurement is for full system

-energy consumption.</tt></dd></dl>

-<dl><dt><a name="Platform-CanMonitorNetworkData">CanMonitorNetworkData</a>(self)</dt><dd><tt>Returns true if network data can be retrieved, false otherwise.</tt></dd></dl>

-<dl><dt><a name="Platform-CanMonitorPower">CanMonitorPower</a>(self)</dt><dd><tt>Returns True iff power can be monitored asynchronously via

-<a href="#Platform-StartMonitoringPower">StartMonitoringPower</a>() and <a href="#Platform-StopMonitoringPower">StopMonitoringPower</a>().</tt></dd></dl>

-<dl><dt><a name="Platform-CanMonitorThermalThrottling">CanMonitorThermalThrottling</a>(self)</dt><dd><tt>Platforms may be able to detect thermal throttling.

-

-Some fan-less computers go into a reduced performance mode when their heat

-exceeds a certain threshold. Performance tests in particular should use this

-API to detect if this has happened and interpret results accordingly.</tt></dd></dl>

-<dl><dt><a name="Platform-CanTakeScreenshot">CanTakeScreenshot</a>(self)</dt></dl>

-<dl><dt><a name="Platform-CooperativelyShutdown">CooperativelyShutdown</a>(self, proc, app_name)</dt><dd><tt>Cooperatively shut down the given process from subprocess.Popen.

-

-Currently this is only implemented on Windows. See

-crbug.com/424024 for background on why it was added.

-

-Args:

-  proc: a process <a href="__builtin__.html#object">object</a> returned from subprocess.Popen.

-  app_name: on Windows, is the prefix of the application's window

-      class name that should be searched for. This helps ensure

-      that only the application's windows are closed.

-

-Returns True if it is believed the attempt succeeded.</tt></dd></dl>

-<dl><dt><a name="Platform-FlushDnsCache">FlushDnsCache</a>(self)</dt><dd><tt>Flushes the OS's DNS cache completely.

-

-This function may require root or administrator access.</tt></dd></dl>

-<dl><dt><a name="Platform-FlushEntireSystemCache">FlushEntireSystemCache</a>(self)</dt><dd><tt>Flushes the OS's file cache completely.

-

-This function may require root or administrator access.</tt></dd></dl>

-<dl><dt><a name="Platform-FlushSystemCacheForDirectory">FlushSystemCacheForDirectory</a>(self, directory)</dt><dd><tt>Flushes the OS's file cache for the specified directory.

-

-This function does not require root or administrator access.</tt></dd></dl>

-<dl><dt><a name="Platform-GetArchName">GetArchName</a>(self)</dt><dd><tt>Returns a string description of the <a href="#Platform">Platform</a> architecture.

-

-Examples: x86_64 (posix), AMD64 (win), armeabi-v7a, x86</tt></dd></dl>

-<dl><dt><a name="Platform-GetDeviceTypeName">GetDeviceTypeName</a>(self)</dt><dd><tt>Returns a string description of the <a href="#Platform">Platform</a> device, or None.

-

-Examples: Nexus 7, Nexus 6, Desktop</tt></dd></dl>

-<dl><dt><a name="Platform-GetNetworkData">GetNetworkData</a>(self, browser)</dt><dd><tt>Get current network data.

-Returns:

-  Tuple of (sent_data, received_data) in kb if data can be found,

-  None otherwise.</tt></dd></dl>

-<dl><dt><a name="Platform-GetOSName">GetOSName</a>(self)</dt><dd><tt>Returns a string description of the <a href="#Platform">Platform</a> OS.

-

-Examples: WIN, MAC, LINUX, CHROMEOS</tt></dd></dl>

-<dl><dt><a name="Platform-GetOSVersionName">GetOSVersionName</a>(self)</dt><dd><tt>Returns a logically sortable, string-like description of the <a href="#Platform">Platform</a> OS

-version.

-

-Examples: VISTA, WIN7, LION, MOUNTAINLION</tt></dd></dl>

-<dl><dt><a name="Platform-GetOSVersionNumber">GetOSVersionNumber</a>(self)</dt><dd><tt>Returns an integer description of the <a href="#Platform">Platform</a> OS major version.

-

-Examples: On Mac, 13 for Mavericks, 14 for Yosemite.</tt></dd></dl>

-<dl><dt><a name="Platform-HasBeenThermallyThrottled">HasBeenThermallyThrottled</a>(self)</dt><dd><tt>Returns True if the device has been thermally throttled.</tt></dd></dl>

-<dl><dt><a name="Platform-InstallApplication">InstallApplication</a>(self, application)</dt><dd><tt>Installs the given application.</tt></dd></dl>

-<dl><dt><a name="Platform-IsApplicationRunning">IsApplicationRunning</a>(self, application)</dt><dd><tt>Returns whether an application is currently running.</tt></dd></dl>

-<dl><dt><a name="Platform-IsCooperativeShutdownSupported">IsCooperativeShutdownSupported</a>(self)</dt><dd><tt>Indicates whether CooperativelyShutdown, below, is supported.

-It is not necessary to implement it on all platforms.</tt></dd></dl>

-<dl><dt><a name="Platform-IsMonitoringPower">IsMonitoringPower</a>(self)</dt><dd><tt>Returns true if power is currently being monitored, false otherwise.</tt></dd></dl>

-<dl><dt><a name="Platform-IsThermallyThrottled">IsThermallyThrottled</a>(self)</dt><dd><tt>Returns True if the device is currently thermally throttled.</tt></dd></dl>

-<dl><dt><a name="Platform-LaunchApplication">LaunchApplication</a>(self, application, parameters=None, elevate_privilege=False)</dt><dd><tt>"Launches the given |application| with a list of |parameters| on the OS.

-

-Set |elevate_privilege| to launch the application with root or admin rights.

-

-Returns:

-  A popen style process handle for host platforms.</tt></dd></dl>

-<dl><dt><a name="Platform-SetHTTPServerDirectories">SetHTTPServerDirectories</a>(self, paths)</dt><dd><tt>Returns True if the HTTP server was started, False otherwise.</tt></dd></dl>

-<dl><dt><a name="Platform-StartLocalServer">StartLocalServer</a>(self, server)</dt><dd><tt>Starts a LocalServer and associates it with this platform.

-|server.Close()| should be called manually to close the started server.</tt></dd></dl>

-<dl><dt><a name="Platform-StartMonitoringPower">StartMonitoringPower</a>(self, browser)</dt><dd><tt>Starts monitoring power utilization statistics.

-

-Args:

-  browser: The browser to monitor.</tt></dd></dl>

-<dl><dt><a name="Platform-StartVideoCapture">StartVideoCapture</a>(self, min_bitrate_mbps)</dt><dd><tt>Starts capturing video.

-

-Outer framing may be included (from the OS, browser window, and webcam).

-

-Args:

-  min_bitrate_mbps: The minimum capture bitrate in MegaBits Per Second.

-      The platform is free to deliver a higher bitrate if it can do so

-      without increasing overhead.

-

-Raises:

-  ValueError if the required |min_bitrate_mbps| can't be achieved.</tt></dd></dl>

-<dl><dt><a name="Platform-StopAllLocalServers">StopAllLocalServers</a>(self)</dt></dl>

-<dl><dt><a name="Platform-StopMonitoringPower">StopMonitoringPower</a>(self)</dt><dd><tt>Stops monitoring power utilization and returns stats

-

-Returns:

-  None if power measurement failed for some reason, otherwise a dict of

-  power utilization statistics containing: {

-    # An identifier for the data provider. Allows to evaluate the precision

-    # of the data. Example values: monsoon, powermetrics, ds2784

-    'identifier': identifier,

-

-    # The instantaneous power (voltage * current) reading in milliwatts at

-    # each sample.

-    'power_samples_mw':  [mw0, mw1, ..., mwN],

-

-    # The full system energy consumption during the sampling period in

-    # milliwatt hours. May be estimated by integrating power samples or may

-    # be exact on supported hardware.

-    'energy_consumption_mwh': mwh,

-

-    # The target application's energy consumption during the sampling period

-    # in milliwatt hours. Should be returned iff

-    # <a href="#Platform-CanMeasurePerApplicationPower">CanMeasurePerApplicationPower</a>() return true.

-    'application_energy_consumption_mwh': mwh,

-

-    # A platform-specific dictionary of additional details about the

-    # utilization of individual hardware components.

-    component_utilization: {

-      ...

-    }

-    # <a href="#Platform">Platform</a>-specific data not attributed to any particular hardware

-    # component.

-    platform_info: {

-

-      # Device-specific onboard temperature sensor.

-      'average_temperature_c': c,

-

-       ...

-    }

-

-  }</tt></dd></dl>

-<dl><dt><a name="Platform-StopVideoCapture">StopVideoCapture</a>(self)</dt><dd><tt>Stops capturing video.

-

-Returns:

-  A telemetry.core.video.Video <a href="__builtin__.html#object">object</a>.</tt></dd></dl>

-<dl><dt><a name="Platform-TakeScreenshot">TakeScreenshot</a>(self, file_path)</dt><dd><tt>Takes a screenshot of the platform and save to |file_path|.

-

-Note that this method may not be supported on all platform, so check with

-CanTakeScreenshot before calling this.

-

-Args:

-  file_path: Where to save the screenshot to. If the platform is remote,

-    |file_path| is the path on the host platform.

-

-Returns True if it is believed the attempt succeeded.</tt></dd></dl>

-<dl><dt><a name="Platform-__init__">__init__</a>(self, platform_backend)</dt></dl>

-<hr>

-Data descriptors defined here:

-<dl><dt>__dict__</dt>

-<dd><tt>dictionary for instance variables (if defined)</tt></dd>

-</dl>

-<dl><dt>__weakref__</dt>

-<dd><tt>list of weak references to the object (if defined)</tt></dd>

-</dl>

-<dl><dt>http_server</dt>

-</dl>

-<dl><dt>is_host_platform</dt>

-</dl>

-<dl><dt>local_servers</dt>

-<dd><tt>Returns the currently running local servers.</tt></dd>

-</dl>

-<dl><dt>network_controller</dt>

-<dd><tt>Control network settings and servers to simulate the Web.</tt></dd>

-</dl>

-<dl><dt>tracing_controller</dt>

-</dl>

-</td></tr></table></td></tr></table>

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#eeaa77">

-<td colspan=3 valign=bottom>

-<big>Functions</big></td></tr>

-<tr><td bgcolor="#eeaa77"><tt>      </tt></td><td> </td>

-<td width="100%"><dl><dt><a name="-GetHostPlatform">GetHostPlatform</a>()</dt></dl>

- <dl><dt><a name="-GetPlatformForDevice">GetPlatformForDevice</a>(device, finder_options, logging=<module 'logging' from '/usr/lib/python2.7/logging/__init__.pyc'>)</dt><dd><tt>Returns a platform instance for the device.

-Args:

-  device: a device.Device instance.</tt></dd></dl>

-</td></tr></table>

-</body></html>