src/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_backend.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html><head><title>Python: module telemetry.core.chrome.desktop_browser_backend</title>
   4 </head><body bgcolor="#f0f0f8">
   5
   6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
   7 <tr bgcolor="#7799ee">
   8 <td valign=bottom>&nbsp;<br>
   9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.core.html"><font color="#ffffff">core</font></a>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.desktop_browser_backend</strong></big></big></font></td
  10 ><td align=right valign=bottom
  11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/core/chrome/desktop_browser_backend.py">telemetry/core/chrome/desktop_browser_backend.py</a></font></td></tr></table>
  12     <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2012&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
  13 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
  14 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
  15 <p>
  16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  17 <tr bgcolor="#aa55cc">
  18 <td colspan=3 valign=bottom>&nbsp;<br>
  19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  20
  21 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.core.chrome.browser_backend.html">telemetry.core.chrome.browser_backend</a><br>
  23 <a href="logging.html">logging</a><br>
  24 </td><td width="25%" valign=top><a href="os.html">os</a><br>
  25 <a href="shutil.html">shutil</a><br>
  26 </td><td width="25%" valign=top><a href="subprocess.html">subprocess</a><br>
  27 <a href="sys.html">sys</a><br>
  28 </td><td width="25%" valign=top><a href="tempfile.html">tempfile</a><br>
  29 <a href="telemetry.core.util.html">telemetry.core.util</a><br>
  30 </td></tr></table></td></tr></table><p>
  31 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  32 <tr bgcolor="#ee77aa">
  33 <td colspan=3 valign=bottom>&nbsp;<br>
  34 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  35
  36 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  37 <td width="100%"><dl>
  38 <dt><font face="helvetica, arial"><a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
  39 </font></dt><dd>
  40 <dl>
  41 <dt><font face="helvetica, arial"><a href="telemetry.core.chrome.desktop_browser_backend.html#DesktopBrowserBackend">DesktopBrowserBackend</a>
  42 </font></dt></dl>
  43 </dd>
  44 </dl>
  45  <p>
  46 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  47 <tr bgcolor="#ffc8d8">
  48 <td colspan=3 valign=bottom>&nbsp;<br>
  49 <font color="#000000" face="helvetica, arial"><a name="DesktopBrowserBackend">class <strong>DesktopBrowserBackend</strong></a>(<a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>)</font></td></tr>
  50
  51 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  52 <td colspan=2><tt>The&nbsp;backend&nbsp;for&nbsp;controlling&nbsp;a&nbsp;locally-executed&nbsp;browser&nbsp;instance,&nbsp;on&nbsp;Linux,<br>
  53 Mac&nbsp;or&nbsp;Windows.<br>&nbsp;</tt></td></tr>
  54 <tr><td>&nbsp;</td>
  55 <td width="100%"><dl><dt>Method resolution order:</dt>
  56 <dd><a href="telemetry.core.chrome.desktop_browser_backend.html#DesktopBrowserBackend">DesktopBrowserBackend</a></dd>
  57 <dd><a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a></dd>
  58 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
  59 </dl>
  60 <hr>
  61 Methods defined here:<br>
  62 <dl><dt><a name="DesktopBrowserBackend-Close"><strong>Close</strong></a>(self)</dt></dl>
  63
  64 <dl><dt><a name="DesktopBrowserBackend-CreateForwarder"><strong>CreateForwarder</strong></a>(self, *port_pairs)</dt></dl>
  65
  66 <dl><dt><a name="DesktopBrowserBackend-GetBrowserStartupArgs"><strong>GetBrowserStartupArgs</strong></a>(self)</dt></dl>
  67
  68 <dl><dt><a name="DesktopBrowserBackend-GetStackTrace"><strong>GetStackTrace</strong></a>(self)</dt></dl>
  69
  70 <dl><dt><a name="DesktopBrowserBackend-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl>
  71
  72 <dl><dt><a name="DesktopBrowserBackend-IsBrowserRunning"><strong>IsBrowserRunning</strong></a>(self)</dt></dl>
  73
  74 <dl><dt><a name="DesktopBrowserBackend-SetProfileDirectory"><strong>SetProfileDirectory</strong></a>(self, profile_dir)</dt></dl>
  75
  76 <dl><dt><a name="DesktopBrowserBackend-__del__"><strong>__del__</strong></a>(self)</dt></dl>
  77
  78 <dl><dt><a name="DesktopBrowserBackend-__init__"><strong>__init__</strong></a>(self, options, executable, flash_path, is_content_shell, delete_profile_dir_after_run<font color="#909090">=True</font>)</dt></dl>
  79
  80 <hr>
  81 Data descriptors defined here:<br>
  82 <dl><dt><strong>pid</strong></dt>
  83 </dl>
  84 <dl><dt><strong>profile_directory</strong></dt>
  85 </dl>
  86 <hr>
  87 Methods inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br>
  88 <dl><dt><a name="DesktopBrowserBackend-GetProcessName"><strong>GetProcessName</strong></a>(self, cmd_line)</dt><dd><tt>Returns&nbsp;a&nbsp;user-friendly&nbsp;name&nbsp;for&nbsp;the&nbsp;process&nbsp;of&nbsp;the&nbsp;given&nbsp;|cmd_line|.</tt></dd></dl>
  89
  90 <dl><dt><a name="DesktopBrowserBackend-GetRemotePort"><strong>GetRemotePort</strong></a>(self, _)</dt></dl>
  91
  92 <dl><dt><a name="DesktopBrowserBackend-GetTraceResultAndReset"><strong>GetTraceResultAndReset</strong></a>(self)</dt></dl>
  93
  94 <dl><dt><a name="DesktopBrowserBackend-Request"><strong>Request</strong></a>(self, path, timeout<font color="#909090">=None</font>)</dt></dl>
  95
  96 <dl><dt><a name="DesktopBrowserBackend-SetBrowser"><strong>SetBrowser</strong></a>(self, browser)</dt></dl>
  97
  98 <dl><dt><a name="DesktopBrowserBackend-StartTracing"><strong>StartTracing</strong></a>(self, custom_categories<font color="#909090">=None</font>, timeout<font color="#909090">=60</font>)</dt><dd><tt>custom_categories&nbsp;is&nbsp;an&nbsp;optional&nbsp;string&nbsp;containing&nbsp;a&nbsp;list&nbsp;of<br>
  99 comma&nbsp;separated&nbsp;categories&nbsp;that&nbsp;will&nbsp;be&nbsp;traced&nbsp;instead&nbsp;of&nbsp;the<br>
 100 default&nbsp;category&nbsp;set.&nbsp;&nbsp;Example:&nbsp;use<br>
 101 "webkit,cc,disabled-by-default-cc.debug"&nbsp;to&nbsp;trace&nbsp;only&nbsp;those&nbsp;three<br>
 102 event&nbsp;categories.</tt></dd></dl>
 103
 104 <dl><dt><a name="DesktopBrowserBackend-StopTracing"><strong>StopTracing</strong></a>(self)</dt></dl>
 105
 106 <hr>
 107 Data descriptors inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br>
 108 <dl><dt><strong>__dict__</strong></dt>
 109 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 110 </dl>
 111 <dl><dt><strong>__weakref__</strong></dt>
 112 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 113 </dl>
 114 <dl><dt><strong>browser</strong></dt>
 115 </dl>
 116 <dl><dt><strong>chrome_branch_number</strong></dt>
 117 </dl>
 118 <dl><dt><strong>extension_dict_backend</strong></dt>
 119 </dl>
 120 <dl><dt><strong>misc_web_contents_backend</strong></dt>
 121 <dd><tt>Access&nbsp;to&nbsp;chrome://oobe/login&nbsp;page&nbsp;which&nbsp;is&nbsp;neither&nbsp;a&nbsp;tab&nbsp;nor&nbsp;an<br>
 122 extension.</tt></dd>
 123 </dl>
 124 <dl><dt><strong>supports_extensions</strong></dt>
 125 <dd><tt>True&nbsp;if&nbsp;this&nbsp;browser&nbsp;backend&nbsp;supports&nbsp;extensions.</tt></dd>
 126 </dl>
 127 <dl><dt><strong>supports_tab_control</strong></dt>
 128 </dl>
 129 <dl><dt><strong>supports_tracing</strong></dt>
 130 </dl>
 131 <dl><dt><strong>tab_list_backend</strong></dt>
 132 </dl>
 133 <dl><dt><strong>wpr_mode</strong></dt>
 134 </dl>
 135 <hr>
 136 Data and other attributes inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br>
 137 <dl><dt><strong>WEBPAGEREPLAY_HOST</strong> = '127.0.0.1'</dl>
 138
 139 </td></tr></table></td></tr></table>
 140 </body></html>