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

Unified Diff: tools/telemetry/docs/pydoc/telemetry.internal.platform.linux_based_platform_backend.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.internal.platform.ios_platform_backend.html ('k') | tools/telemetry/docs/pydoc/telemetry.internal.platform.linux_platform_backend.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/pydoc/telemetry.internal.platform.linux_based_platform_backend.html

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

deleted file mode 100644

index bba83562090ca47eb5ea9f26a054c13eed393a11..0000000000000000000000000000000000000000

--- a/tools/telemetry/docs/pydoc/telemetry.internal.platform.linux_based_platform_backend.html

+++ /dev/null

@@ -1,278 +0,0 @@

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

-<html><head><title>Python: module telemetry.internal.platform.linux_based_platform_backend</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.internal.html">internal</a>.<a href="telemetry.internal.platform.html">platform</a>.linux_based_platform_backend</big></big></td

-><td align=right valign=bottom

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

- <tt># Copyright 2013 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.decorators.html">telemetry.decorators</a>

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

-</td><td width="25%" valign=top><a href="telemetry.internal.platform.platform_backend.html">telemetry.internal.platform.platform_backend</a>

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

-</td><td width="25%" valign=top><a href="resource.html">resource</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="telemetry.internal.platform.platform_backend.html#PlatformBackend">telemetry.internal.platform.platform_backend.PlatformBackend</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

-</dt><dd>

-<dl>

-<dt><a href="telemetry.internal.platform.linux_based_platform_backend.html#LinuxBasedPlatformBackend">LinuxBasedPlatformBackend</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="LinuxBasedPlatformBackend">class LinuxBasedPlatformBackend</a>(<a href="telemetry.internal.platform.platform_backend.html#PlatformBackend">telemetry.internal.platform.platform_backend.PlatformBackend</a>)</td></tr>

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

-<td colspan=2><tt>Abstract platform containing functionality shared by all Linux based OSes.

-

-This includes Android and ChromeOS.

-

-Subclasses must implement RunCommand, GetFileContents, GetPsOutput, and

-ParseCStateSample.  </tt></td></tr>

-<tr><td> </td>

-<td width="100%"><dl><dt>Method resolution order:</dt>

-<dd><a href="telemetry.internal.platform.linux_based_platform_backend.html#LinuxBasedPlatformBackend">LinuxBasedPlatformBackend</a></dd>

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

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

-</dl>

-<hr>

-Methods defined here:

-<dl><dt><a name="LinuxBasedPlatformBackend-GetClockTicks">GetClockTicks</a>(*args, **kwargs)</dt><dd><tt>Returns the number of clock ticks per second.

-

-The proper way is to call os.sysconf('SC_CLK_TCK') but that is not easy to

-do on Android/CrOS. In practice, nearly all Linux machines have a USER_HZ

-of 100, so just return that.</tt></dd></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetCpuStats">GetCpuStats</a>(self, pid)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetCpuTimestamp">GetCpuTimestamp</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetFileContents">GetFileContents</a>(self, filename)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetMemoryStats">GetMemoryStats</a>(self, pid)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetPsOutput">GetPsOutput</a>(self, columns, pid=None)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetSystemCommitCharge">GetSystemCommitCharge</a>(self)</dt><dd><tt># Get the commit charge in kB.</tt></dd></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetSystemTotalPhysicalMemory">GetSystemTotalPhysicalMemory</a>(*args, **kwargs)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-RunCommand">RunCommand</a>(self, cmd)</dt><dd><tt>Runs the specified command.

-

-Args:

-    cmd: A list of program arguments or the path string of the program.

-Returns:

-    A string whose content is the output of the command.</tt></dd></dl>

-<hr>

-Static methods defined here:

-<dl><dt><a name="LinuxBasedPlatformBackend-ParseCStateSample">ParseCStateSample</a>(sample)</dt><dd><tt>Parse a single c-state residency sample.

-

-    Args:

-        sample: A sample of c-state residency times to be parsed. Organized as

-            a dictionary mapping CPU name to a string containing all c-state

-            names, the times in each state, the latency of each state, and the

-            time at which the sample was taken all separated by newlines.

-            Ex: {'cpu0': 'C0

-C1

-5000

-2000

-20

-30

-1406673171'}

-

-    Returns:

-        Dictionary associating a c-state with a time.</tt></dd></dl>

-<hr>

-Methods inherited from <a href="telemetry.internal.platform.platform_backend.html#PlatformBackend">telemetry.internal.platform.platform_backend.PlatformBackend</a>:

-<dl><dt><a name="LinuxBasedPlatformBackend-CanCaptureVideo">CanCaptureVideo</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-CanFlushIndividualFilesFromSystemCache">CanFlushIndividualFilesFromSystemCache</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-CanLaunchApplication">CanLaunchApplication</a>(self, application)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-CanMeasurePerApplicationPower">CanMeasurePerApplicationPower</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-CanMonitorNetworkData">CanMonitorNetworkData</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-CanMonitorPower">CanMonitorPower</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-CanMonitorThermalThrottling">CanMonitorThermalThrottling</a>(self)</dt></dl>

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

-<dl><dt><a name="LinuxBasedPlatformBackend-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 object 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="LinuxBasedPlatformBackend-DidCreateBrowser">DidCreateBrowser</a>(self, browser, browser_backend)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-DidStartBrowser">DidStartBrowser</a>(self, browser, browser_backend)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-FlushDnsCache">FlushDnsCache</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-FlushEntireSystemCache">FlushEntireSystemCache</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-FlushSystemCacheForDirectory">FlushSystemCacheForDirectory</a>(self, directory)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetArchName">GetArchName</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetChildPids">GetChildPids</a>(self, pid)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetCommandLine">GetCommandLine</a>(self, pid)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetDeviceTypeName">GetDeviceTypeName</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetNetworkData">GetNetworkData</a>(self, browser)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetOSName">GetOSName</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetOSVersionName">GetOSVersionName</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-GetRemotePort">GetRemotePort</a>(self, port)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-HasBeenThermallyThrottled">HasBeenThermallyThrottled</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-InitPlatformBackend">InitPlatformBackend</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-InstallApplication">InstallApplication</a>(self, application)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-IsApplicationRunning">IsApplicationRunning</a>(self, application)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-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="LinuxBasedPlatformBackend-IsDisplayTracingSupported">IsDisplayTracingSupported</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-IsThermallyThrottled">IsThermallyThrottled</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-LaunchApplication">LaunchApplication</a>(self, application, parameters=None, elevate_privilege=False)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-PathExists">PathExists</a>(self, path, timeout=None, retries=None)</dt><dd><tt>Tests whether the given path exists on the target platform.

-Args:

-  path: path in request.

-  timeout: timeout.

-  retries: num of retries.

-Return:

-  Whether the path exists on the target platform.</tt></dd></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-PurgeUnpinnedMemory">PurgeUnpinnedMemory</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-ReadMsr">ReadMsr</a>(self, msr_number, start=0, length=64)</dt><dd><tt>Read a CPU model-specific register (MSR).

-

-Which MSRs are available depends on the CPU model.

-On systems with multiple CPUs, this function may run on any CPU.

-

-Args:

-  msr_number: The number of the register to read.

-  start: The least significant bit to read, zero-indexed.

-      (Said another way, the number of bits to right-shift the MSR value.)

-  length: The number of bits to read. MSRs are 64 bits, even on 32-bit CPUs.</tt></dd></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-SetFullPerformanceModeEnabled">SetFullPerformanceModeEnabled</a>(self, enabled)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-SetPlatform">SetPlatform</a>(self, platform)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-StartDisplayTracing">StartDisplayTracing</a>(self)</dt><dd><tt>Start gathering a trace with frame timestamps close to physical

-display.</tt></dd></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-StartMonitoringPower">StartMonitoringPower</a>(self, browser)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-StartVideoCapture">StartVideoCapture</a>(self, min_bitrate_mbps)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-StopDisplayTracing">StopDisplayTracing</a>(self)</dt><dd><tt>Stop gathering a trace with frame timestamps close to physical display.

-

-Returns a raw tracing events that contains the timestamps of physical

-display.</tt></dd></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-StopMonitoringPower">StopMonitoringPower</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-StopVideoCapture">StopVideoCapture</a>(self)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-TakeScreenshot">TakeScreenshot</a>(self, file_path)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-WillCloseBrowser">WillCloseBrowser</a>(self, browser, browser_backend)</dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-__init__">__init__</a>(self, device=None)</dt><dd><tt>Initalize an instance of <a href="telemetry.internal.platform.platform_backend.html#PlatformBackend">PlatformBackend</a> from a device optionally.

-Call sites need to use SupportsDevice before intialization to check

-whether this platform backend supports the device.

-If device is None, this constructor returns the host platform backend

-which telemetry is running on.

-

-Args:

-  device: an instance of telemetry.core.platform.device.Device.</tt></dd></dl>

-<hr>

-Class methods inherited from <a href="telemetry.internal.platform.platform_backend.html#PlatformBackend">telemetry.internal.platform.platform_backend.PlatformBackend</a>:

-<dl><dt><a name="LinuxBasedPlatformBackend-CreatePlatformForDevice">CreatePlatformForDevice</a>(cls, device, finder_options) from <a href="__builtin__.html#type">__builtin__.type</a></dt></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-IsPlatformBackendForHost">IsPlatformBackendForHost</a>(cls) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Returns whether this platform backend is the platform backend to be used

-for the host device which telemetry is running on.</tt></dd></dl>

-<dl><dt><a name="LinuxBasedPlatformBackend-SupportsDevice">SupportsDevice</a>(cls, device) from <a href="__builtin__.html#type">__builtin__.type</a></dt><dd><tt>Returns whether this platform backend supports intialization from the

-device.</tt></dd></dl>

-<hr>

-Data descriptors inherited from <a href="telemetry.internal.platform.platform_backend.html#PlatformBackend">telemetry.internal.platform.platform_backend.PlatformBackend</a>:

-<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>forwarder_factory</dt>

-</dl>

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

-</dl>

-<dl><dt>is_video_capture_running</dt>

-</dl>

-<dl><dt>network_controller_backend</dt>

-</dl>

-<dl><dt>platform</dt>

-</dl>

-<dl><dt>running_browser_backends</dt>

-</dl>

-<dl><dt>tracing_controller_backend</dt>

-</dl>

-<dl><dt>wpr_ca_cert_path</dt>

-</dl>

-<dl><dt>wpr_http_device_port</dt>

-</dl>

-<dl><dt>wpr_https_device_port</dt>

-</dl>

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

-</body></html>