Home | History | Annotate | Download | only in docs
      1 
      2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
      3 <html><head><title>Python: module telemetry.core.chrome.cros_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>.cros_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/cros_browser_backend.py">telemetry/core/chrome/cros_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="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br>
     24 </td><td width="25%" valign=top><a href="logging.html">logging</a><br>
     25 <a href="os.html">os</a><br>
     26 </td><td width="25%" valign=top><a href="subprocess.html">subprocess</a><br>
     27 <a href="telemetry.core.util.html">telemetry.core.util</a><br>
     28 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
     29 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     30 <tr bgcolor="#ee77aa">
     31 <td colspan=3 valign=bottom>&nbsp;<br>
     32 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
     33     
     34 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     35 <td width="100%"><dl>
     36 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
     37 </font></dt><dd>
     38 <dl>
     39 <dt><font face="helvetica, arial"><a href="telemetry.core.chrome.cros_browser_backend.html#SSHForwarder">SSHForwarder</a>
     40 </font></dt></dl>
     41 </dd>
     42 <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>)
     43 </font></dt><dd>
     44 <dl>
     45 <dt><font face="helvetica, arial"><a href="telemetry.core.chrome.cros_browser_backend.html#CrOSBrowserBackend">CrOSBrowserBackend</a>
     46 </font></dt></dl>
     47 </dd>
     48 </dl>
     49  <p>
     50 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     51 <tr bgcolor="#ffc8d8">
     52 <td colspan=3 valign=bottom>&nbsp;<br>
     53 <font color="#000000" face="helvetica, arial"><a name="CrOSBrowserBackend">class <strong>CrOSBrowserBackend</strong></a>(<a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>)</font></td></tr>
     54     
     55 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     56 <td width="100%"><dl><dt>Method resolution order:</dt>
     57 <dd><a href="telemetry.core.chrome.cros_browser_backend.html#CrOSBrowserBackend">CrOSBrowserBackend</a></dd>
     58 <dd><a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a></dd>
     59 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
     60 </dl>
     61 <hr>
     62 Methods defined here:<br>
     63 <dl><dt><a name="CrOSBrowserBackend-Close"><strong>Close</strong></a>(self)</dt></dl>
     64 
     65 <dl><dt><a name="CrOSBrowserBackend-CreateForwarder"><strong>CreateForwarder</strong></a>(self, *port_pairs)</dt></dl>
     66 
     67 <dl><dt><a name="CrOSBrowserBackend-GetBrowserStartupArgs"><strong>GetBrowserStartupArgs</strong></a>(self)</dt></dl>
     68 
     69 <dl><dt><a name="CrOSBrowserBackend-GetRemotePort"><strong>GetRemotePort</strong></a>(self, _)</dt></dl>
     70 
     71 <dl><dt><a name="CrOSBrowserBackend-GetStackTrace"><strong>GetStackTrace</strong></a>(self)</dt></dl>
     72 
     73 <dl><dt><a name="CrOSBrowserBackend-GetStandardOutput"><strong>GetStandardOutput</strong></a>(self)</dt></dl>
     74 
     75 <dl><dt><a name="CrOSBrowserBackend-IsBrowserRunning"><strong>IsBrowserRunning</strong></a>(self)</dt></dl>
     76 
     77 <dl><dt><a name="CrOSBrowserBackend-__del__"><strong>__del__</strong></a>(self)</dt></dl>
     78 
     79 <dl><dt><a name="CrOSBrowserBackend-__init__"><strong>__init__</strong></a>(self, browser_type, options, cri, is_guest)</dt></dl>
     80 
     81 <hr>
     82 Data descriptors defined here:<br>
     83 <dl><dt><strong>hwid</strong></dt>
     84 </dl>
     85 <dl><dt><strong>oobe</strong></dt>
     86 </dl>
     87 <dl><dt><strong>pid</strong></dt>
     88 <dd><tt>Locates&nbsp;the&nbsp;pid&nbsp;of&nbsp;the&nbsp;main&nbsp;chrome&nbsp;browser&nbsp;process.<br>
     89 &nbsp;<br>
     90 Chrome&nbsp;on&nbsp;cros&nbsp;is&nbsp;usually&nbsp;in&nbsp;/opt/google/chrome,&nbsp;but&nbsp;could&nbsp;be&nbsp;in<br>
     91 /usr/local/&nbsp;for&nbsp;developer&nbsp;workflows&nbsp;-&nbsp;debug&nbsp;chrome&nbsp;is&nbsp;too&nbsp;large&nbsp;to&nbsp;fit&nbsp;on<br>
     92 rootfs.<br>
     93 &nbsp;<br>
     94 Chrome&nbsp;spawns&nbsp;multiple&nbsp;processes&nbsp;for&nbsp;renderers.&nbsp;pids&nbsp;wrap&nbsp;around&nbsp;after&nbsp;they<br>
     95 are&nbsp;exhausted&nbsp;so&nbsp;looking&nbsp;for&nbsp;the&nbsp;smallest&nbsp;pid&nbsp;is&nbsp;not&nbsp;always&nbsp;correct.&nbsp;We<br>
     96 locate&nbsp;the&nbsp;session_manager's&nbsp;pid,&nbsp;and&nbsp;look&nbsp;for&nbsp;the&nbsp;chrome&nbsp;process&nbsp;that's&nbsp;an<br>
     97 immediate&nbsp;child.&nbsp;This&nbsp;is&nbsp;the&nbsp;main&nbsp;browser&nbsp;process.</tt></dd>
     98 </dl>
     99 <hr>
    100 Data and other attributes defined here:<br>
    101 <dl><dt><strong>CHROME_PATHS</strong> = ['/opt/google/chrome/chrome ', '/usr/local/opt/google/chrome/chrome ']</dl>
    102 
    103 <hr>
    104 Methods inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br>
    105 <dl><dt><a name="CrOSBrowserBackend-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>
    106 
    107 <dl><dt><a name="CrOSBrowserBackend-GetTraceResultAndReset"><strong>GetTraceResultAndReset</strong></a>(self)</dt></dl>
    108 
    109 <dl><dt><a name="CrOSBrowserBackend-Request"><strong>Request</strong></a>(self, path, timeout<font color="#909090">=None</font>)</dt></dl>
    110 
    111 <dl><dt><a name="CrOSBrowserBackend-SetBrowser"><strong>SetBrowser</strong></a>(self, browser)</dt></dl>
    112 
    113 <dl><dt><a name="CrOSBrowserBackend-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>
    114 comma&nbsp;separated&nbsp;categories&nbsp;that&nbsp;will&nbsp;be&nbsp;traced&nbsp;instead&nbsp;of&nbsp;the<br>
    115 default&nbsp;category&nbsp;set.&nbsp;&nbsp;Example:&nbsp;use<br>
    116 "webkit,cc,disabled-by-default-cc.debug"&nbsp;to&nbsp;trace&nbsp;only&nbsp;those&nbsp;three<br>
    117 event&nbsp;categories.</tt></dd></dl>
    118 
    119 <dl><dt><a name="CrOSBrowserBackend-StopTracing"><strong>StopTracing</strong></a>(self)</dt></dl>
    120 
    121 <hr>
    122 Data descriptors inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br>
    123 <dl><dt><strong>__dict__</strong></dt>
    124 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
    125 </dl>
    126 <dl><dt><strong>__weakref__</strong></dt>
    127 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
    128 </dl>
    129 <dl><dt><strong>browser</strong></dt>
    130 </dl>
    131 <dl><dt><strong>chrome_branch_number</strong></dt>
    132 </dl>
    133 <dl><dt><strong>extension_dict_backend</strong></dt>
    134 </dl>
    135 <dl><dt><strong>misc_web_contents_backend</strong></dt>
    136 <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>
    137 extension.</tt></dd>
    138 </dl>
    139 <dl><dt><strong>supports_extensions</strong></dt>
    140 <dd><tt>True&nbsp;if&nbsp;this&nbsp;browser&nbsp;backend&nbsp;supports&nbsp;extensions.</tt></dd>
    141 </dl>
    142 <dl><dt><strong>supports_tab_control</strong></dt>
    143 </dl>
    144 <dl><dt><strong>supports_tracing</strong></dt>
    145 </dl>
    146 <dl><dt><strong>tab_list_backend</strong></dt>
    147 </dl>
    148 <dl><dt><strong>wpr_mode</strong></dt>
    149 </dl>
    150 <hr>
    151 Data and other attributes inherited from <a href="telemetry.core.chrome.browser_backend.html#BrowserBackend">telemetry.core.chrome.browser_backend.BrowserBackend</a>:<br>
    152 <dl><dt><strong>WEBPAGEREPLAY_HOST</strong> = '127.0.0.1'</dl>
    153 
    154 </td></tr></table> <p>
    155 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
    156 <tr bgcolor="#ffc8d8">
    157 <td colspan=3 valign=bottom>&nbsp;<br>
    158 <font color="#000000" face="helvetica, arial"><a name="SSHForwarder">class <strong>SSHForwarder</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
    159     
    160 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
    161 <td width="100%">Methods defined here:<br>
    162 <dl><dt><a name="SSHForwarder-Close"><strong>Close</strong></a>(self)</dt></dl>
    163 
    164 <dl><dt><a name="SSHForwarder-__init__"><strong>__init__</strong></a>(self, cri, forwarding_flag, *port_pairs)</dt></dl>
    165 
    166 <hr>
    167 Data descriptors defined here:<br>
    168 <dl><dt><strong>__dict__</strong></dt>
    169 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
    170 </dl>
    171 <dl><dt><strong>__weakref__</strong></dt>
    172 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
    173 </dl>
    174 <dl><dt><strong>url</strong></dt>
    175 </dl>
    176 </td></tr></table></td></tr></table>
    177 </body></html>