| Index: tools/telemetry/docs/pydoc/telemetry.internal.backends.chrome_inspector.devtools_client_backend.html
|
| diff --git a/tools/telemetry/docs/pydoc/telemetry.internal.backends.chrome_inspector.devtools_client_backend.html b/tools/telemetry/docs/pydoc/telemetry.internal.backends.chrome_inspector.devtools_client_backend.html
|
| deleted file mode 100644
|
| index ff536e30e4d7e27cf8a1614cc59c2f9b27babb53..0000000000000000000000000000000000000000
|
| --- a/tools/telemetry/docs/pydoc/telemetry.internal.backends.chrome_inspector.devtools_client_backend.html
|
| +++ /dev/null
|
| @@ -1,284 +0,0 @@
|
| -
|
| -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
| -<html><head><title>Python: module telemetry.internal.backends.chrome_inspector.devtools_client_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> <br>
|
| -<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.backends.html"><font color="#ffffff">backends</font></a>.<a href="telemetry.internal.backends.chrome_inspector.html"><font color="#ffffff">chrome_inspector</font></a>.devtools_client_backend</strong></big></big></font></td
|
| -><td align=right valign=bottom
|
| -><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/backends/chrome_inspector/devtools_client_backend.py">telemetry/internal/backends/chrome_inspector/devtools_client_backend.py</a></font></td></tr></table>
|
| - <p><tt># Copyright 2014 The Chromium Authors. All rights reserved.<br>
|
| -# Use of this source code is governed by a BSD-style license that can be<br>
|
| -# found in the LICENSE file.</tt></p>
|
| -<p>
|
| -<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
| -<tr bgcolor="#aa55cc">
|
| -<td colspan=3 valign=bottom> <br>
|
| -<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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.internal.backends.browser_backend.html">telemetry.internal.backends.browser_backend</a><br>
|
| -<a href="telemetry.internal.platform.tracing_agent.chrome_tracing_agent.html">telemetry.internal.platform.tracing_agent.chrome_tracing_agent</a><br>
|
| -<a href="telemetry.internal.platform.tracing_agent.chrome_tracing_devtools_manager.html">telemetry.internal.platform.tracing_agent.chrome_tracing_devtools_manager</a><br>
|
| -<a href="telemetry.decorators.html">telemetry.decorators</a><br>
|
| -</td><td width="25%" valign=top><a href="telemetry.internal.backends.chrome_inspector.devtools_http.html">telemetry.internal.backends.chrome_inspector.devtools_http</a><br>
|
| -<a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br>
|
| -<a href="telemetry.internal.backends.chrome_inspector.inspector_backend.html">telemetry.internal.backends.chrome_inspector.inspector_backend</a><br>
|
| -<a href="telemetry.internal.backends.chrome_inspector.inspector_websocket.html">telemetry.internal.backends.chrome_inspector.inspector_websocket</a><br>
|
| -</td><td width="25%" valign=top><a href="logging.html">logging</a><br>
|
| -<a href="telemetry.internal.backends.chrome_inspector.memory_backend.html">telemetry.internal.backends.chrome_inspector.memory_backend</a><br>
|
| -<a href="re.html">re</a><br>
|
| -<a href="socket.html">socket</a><br>
|
| -</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
|
| -<a href="telemetry.timeline.trace_data.html">telemetry.timeline.trace_data</a><br>
|
| -<a href="telemetry.internal.backends.chrome_inspector.tracing_backend.html">telemetry.internal.backends.chrome_inspector.tracing_backend</a><br>
|
| -<a href="telemetry.internal.backends.chrome_inspector.websocket.html">telemetry.internal.backends.chrome_inspector.websocket</a><br>
|
| -</td></tr></table></td></tr></table><p>
|
| -<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
| -<tr bgcolor="#ee77aa">
|
| -<td colspan=3 valign=bottom> <br>
|
| -<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
| -
|
| -<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
| -<td width="100%"><dl>
|
| -<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
|
| -</font></dt><dd>
|
| -<dl>
|
| -<dt><font face="helvetica, arial"><a href="telemetry.internal.backends.chrome_inspector.devtools_client_backend.html#DevToolsClientBackend">DevToolsClientBackend</a>
|
| -</font></dt></dl>
|
| -</dd>
|
| -<dt><font face="helvetica, arial"><a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)
|
| -</font></dt><dd>
|
| -<dl>
|
| -<dt><font face="helvetica, arial"><a href="telemetry.internal.backends.chrome_inspector.devtools_client_backend.html#TabNotFoundError">TabNotFoundError</a>
|
| -</font></dt></dl>
|
| -</dd>
|
| -</dl>
|
| - <p>
|
| -<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
| -<tr bgcolor="#ffc8d8">
|
| -<td colspan=3 valign=bottom> <br>
|
| -<font color="#000000" face="helvetica, arial"><a name="DevToolsClientBackend">class <strong>DevToolsClientBackend</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
| -
|
| -<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
| -<td colspan=2><tt>An <a href="__builtin__.html#object">object</a> that communicates with Chrome's devtools.<br>
|
| - <br>
|
| -This class owns a map of InspectorBackends. It is responsible for creating<br>
|
| -them and destroying them.<br> </tt></td></tr>
|
| -<tr><td> </td>
|
| -<td width="100%">Methods defined here:<br>
|
| -<dl><dt><a name="DevToolsClientBackend-ActivateTab"><strong>ActivateTab</strong></a>(self, tab_id, timeout)</dt><dd><tt>Activates the tab with the given id.<br>
|
| - <br>
|
| -Raises:<br>
|
| - devtools_http.DevToolsClientConnectionError<br>
|
| - <a href="#TabNotFoundError">TabNotFoundError</a></tt></dd></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-Close"><strong>Close</strong></a>(self)</dt></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-CloseTab"><strong>CloseTab</strong></a>(self, tab_id, timeout)</dt><dd><tt>Closes the tab with the given id.<br>
|
| - <br>
|
| -Raises:<br>
|
| - devtools_http.DevToolsClientConnectionError<br>
|
| - <a href="#TabNotFoundError">TabNotFoundError</a></tt></dd></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-DumpMemory"><strong>DumpMemory</strong></a>(self, timeout<font color="#909090">=30</font>)</dt><dd><tt>Dumps memory.<br>
|
| - <br>
|
| -Returns:<br>
|
| - GUID of the generated dump if successful, None otherwise.<br>
|
| - <br>
|
| -Raises:<br>
|
| - TracingTimeoutException: If more than |timeout| seconds has passed<br>
|
| - since the last time any data is received.<br>
|
| - TracingUnrecoverableException: If there is a websocket error.<br>
|
| - TracingUnexpectedResponseException: If the response contains an error<br>
|
| - or does not contain the expected result.</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-GetChromeBranchNumber"><strong>GetChromeBranchNumber</strong></a>(*args, **kwargs)</dt></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-GetUpdatedInspectableContexts"><strong>GetUpdatedInspectableContexts</strong></a>(self)</dt><dd><tt>Returns an updated instance of _DevToolsContextMapBackend.</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-GetUrl"><strong>GetUrl</strong></a>(self, tab_id)</dt><dd><tt>Returns the URL of the tab with |tab_id|, as reported by devtools.<br>
|
| - <br>
|
| -Raises:<br>
|
| - devtools_http.DevToolsClientConnectionError</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-IsAlive"><strong>IsAlive</strong></a>(self)</dt><dd><tt>Whether the DevTools server is available and connectable.</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-IsChromeTracingSupported"><strong>IsChromeTracingSupported</strong></a>(self)</dt></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-IsInspectable"><strong>IsInspectable</strong></a>(self, tab_id)</dt><dd><tt>Whether the tab with |tab_id| is inspectable, as reported by devtools.<br>
|
| - <br>
|
| -Raises:<br>
|
| - devtools_http.DevToolsClientConnectionError</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-RequestNewTab"><strong>RequestNewTab</strong></a>(self, timeout)</dt><dd><tt>Creates a new tab.<br>
|
| - <br>
|
| -Returns:<br>
|
| - A JSON string as returned by DevTools. Example:<br>
|
| - {<br>
|
| - "description": "",<br>
|
| - "devtoolsFrontendUrl":<br>
|
| - "/devtools/inspector.html?ws=host:port/devtools/page/id-string",<br>
|
| - "id": "id-string",<br>
|
| - "title": "Page Title",<br>
|
| - "type": "page",<br>
|
| - "url": "url",<br>
|
| - "webSocketDebuggerUrl": "ws://host:port/devtools/page/id-string"<br>
|
| - }<br>
|
| - <br>
|
| -Raises:<br>
|
| - devtools_http.DevToolsClientConnectionError</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-SetMemoryPressureNotificationsSuppressed"><strong>SetMemoryPressureNotificationsSuppressed</strong></a>(self, suppressed, timeout<font color="#909090">=30</font>)</dt><dd><tt>Enable/disable suppressing memory pressure notifications.<br>
|
| - <br>
|
| -Args:<br>
|
| - suppressed: If true, memory pressure notifications will be suppressed.<br>
|
| - timeout: The timeout in seconds.<br>
|
| - <br>
|
| -Raises:<br>
|
| - MemoryTimeoutException: If more than |timeout| seconds has passed<br>
|
| - since the last time any data is received.<br>
|
| - MemoryUnrecoverableException: If there is a websocket error.<br>
|
| - MemoryUnexpectedResponseException: If the response contains an error<br>
|
| - or does not contain the expected result.</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-SimulateMemoryPressureNotification"><strong>SimulateMemoryPressureNotification</strong></a>(self, pressure_level, timeout<font color="#909090">=30</font>)</dt><dd><tt>Simulate a memory pressure notification.<br>
|
| - <br>
|
| -Args:<br>
|
| - pressure level: The memory pressure level of the notification ('moderate'<br>
|
| - or 'critical').<br>
|
| - timeout: The timeout in seconds.<br>
|
| - <br>
|
| -Raises:<br>
|
| - MemoryTimeoutException: If more than |timeout| seconds has passed<br>
|
| - since the last time any data is received.<br>
|
| - MemoryUnrecoverableException: If there is a websocket error.<br>
|
| - MemoryUnexpectedResponseException: If the response contains an error<br>
|
| - or does not contain the expected result.</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-StartChromeTracing"><strong>StartChromeTracing</strong></a>(self, trace_options, custom_categories<font color="#909090">=None</font>, timeout<font color="#909090">=10</font>)</dt><dd><tt>Args:<br>
|
| - trace_options: An tracing_options.TracingOptions instance.<br>
|
| - custom_categories: An optional string containing a list of<br>
|
| - comma separated categories that will be traced<br>
|
| - instead of the default category set. Example: use<br>
|
| - "webkit,cc,disabled-by-default-cc.debug" to trace only<br>
|
| - those three event categories.</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-StopChromeTracing"><strong>StopChromeTracing</strong></a>(self, trace_data_builder, timeout<font color="#909090">=30</font>)</dt></dl>
|
| -
|
| -<dl><dt><a name="DevToolsClientBackend-__init__"><strong>__init__</strong></a>(self, devtools_port, remote_devtools_port, app_backend)</dt><dd><tt>Creates a new <a href="#DevToolsClientBackend">DevToolsClientBackend</a>.<br>
|
| - <br>
|
| -A DevTools agent must exist on the given devtools_port.<br>
|
| - <br>
|
| -Args:<br>
|
| - devtools_port: The port to use to connect to DevTools agent.<br>
|
| - remote_devtools_port: In some cases (e.g., app running on<br>
|
| - Android device, devtools_port is the forwarded port on the<br>
|
| - host platform. We also need to know the remote_devtools_port<br>
|
| - so that we can uniquely identify the DevTools agent.<br>
|
| - app_backend: For the app that contains the DevTools agent.</tt></dd></dl>
|
| -
|
| -<hr>
|
| -Data descriptors defined here:<br>
|
| -<dl><dt><strong>__dict__</strong></dt>
|
| -<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
| -</dl>
|
| -<dl><dt><strong>__weakref__</strong></dt>
|
| -<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
| -</dl>
|
| -<dl><dt><strong>is_tracing_running</strong></dt>
|
| -</dl>
|
| -<dl><dt><strong>remote_port</strong></dt>
|
| -</dl>
|
| -<dl><dt><strong>support_startup_tracing</strong></dt>
|
| -</dl>
|
| -<dl><dt><strong>supports_overriding_memory_pressure_notifications</strong></dt>
|
| -</dl>
|
| -<dl><dt><strong>supports_tracing</strong></dt>
|
| -</dl>
|
| -</td></tr></table> <p>
|
| -<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
| -<tr bgcolor="#ffc8d8">
|
| -<td colspan=3 valign=bottom> <br>
|
| -<font color="#000000" face="helvetica, arial"><a name="TabNotFoundError">class <strong>TabNotFoundError</strong></a>(<a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>)</font></td></tr>
|
| -
|
| -<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
|
| -<td width="100%"><dl><dt>Method resolution order:</dt>
|
| -<dd><a href="telemetry.internal.backends.chrome_inspector.devtools_client_backend.html#TabNotFoundError">TabNotFoundError</a></dd>
|
| -<dd><a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a></dd>
|
| -<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
|
| -<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
| -<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
| -</dl>
|
| -<hr>
|
| -Methods inherited from <a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>:<br>
|
| -<dl><dt><a name="TabNotFoundError-AddDebuggingMessage"><strong>AddDebuggingMessage</strong></a>(self, msg)</dt><dd><tt>Adds a message to the description of the exception.<br>
|
| - <br>
|
| -Many Telemetry exceptions arise from failures in another application. These<br>
|
| -failures are difficult to pinpoint. This method allows Telemetry classes to<br>
|
| -append useful debugging information to the exception. This method also logs<br>
|
| -information about the location from where it was called.</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="TabNotFoundError-__init__"><strong>__init__</strong></a>(self, msg<font color="#909090">=''</font>)</dt></dl>
|
| -
|
| -<dl><dt><a name="TabNotFoundError-__str__"><strong>__str__</strong></a>(self)</dt></dl>
|
| -
|
| -<hr>
|
| -Data descriptors inherited from <a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>:<br>
|
| -<dl><dt><strong>__weakref__</strong></dt>
|
| -<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
| -</dl>
|
| -<hr>
|
| -Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
| -<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#TabNotFoundError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
|
| -
|
| -<hr>
|
| -Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
| -<dl><dt><a name="TabNotFoundError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TabNotFoundError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="TabNotFoundError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#TabNotFoundError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="TabNotFoundError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#TabNotFoundError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="TabNotFoundError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#TabNotFoundError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
| - <br>
|
| -Use of negative indices is not supported.</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="TabNotFoundError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
| -
|
| -<dl><dt><a name="TabNotFoundError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#TabNotFoundError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="TabNotFoundError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#TabNotFoundError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
|
| -
|
| -<dl><dt><a name="TabNotFoundError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
| -
|
| -<dl><dt><a name="TabNotFoundError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
| -
|
| -<hr>
|
| -Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
| -<dl><dt><strong>__dict__</strong></dt>
|
| -</dl>
|
| -<dl><dt><strong>args</strong></dt>
|
| -</dl>
|
| -<dl><dt><strong>message</strong></dt>
|
| -</dl>
|
| -</td></tr></table></td></tr></table><p>
|
| -<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
| -<tr bgcolor="#eeaa77">
|
| -<td colspan=3 valign=bottom> <br>
|
| -<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
| -
|
| -<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
| -<td width="100%"><dl><dt><a name="-IsDevToolsAgentAvailable"><strong>IsDevToolsAgentAvailable</strong></a>(port, app_backend)</dt><dd><tt>Returns True if a DevTools agent is available on the given port.</tt></dd></dl>
|
| -</td></tr></table><p>
|
| -<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
| -<tr bgcolor="#55aa55">
|
| -<td colspan=3 valign=bottom> <br>
|
| -<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
| -
|
| -<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
| -<td width="100%"><strong>BROWSER_INSPECTOR_WEBSOCKET_URL</strong> = 'ws://127.0.0.1:%i/devtools/browser'</td></tr></table>
|
| -</body></html>
|
|
|