1 2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3 <html><head><title>Python: package telemetry.internal.platform.tracing_agent</title> 4 <meta charset="utf-8"> 5 </head><body bgcolor="#f0f0f8"> 6 7 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> 8 <tr bgcolor="#7799ee"> 9 <td valign=bottom> <br> 10 <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.platform.html"><font color="#ffffff">platform</font></a>.tracing_agent</strong></big></big></font></td 11 ><td align=right valign=bottom 12 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/platform/tracing_agent/__init__.py">telemetry/internal/platform/tracing_agent/__init__.py</a></font></td></tr></table> 13 <p><tt># Copyright 2014 The Chromium Authors. All rights reserved.<br> 14 # Use of this source code is governed by a BSD-style license that can be<br> 15 # found in the LICENSE file.</tt></p> 16 <p> 17 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 18 <tr bgcolor="#aa55cc"> 19 <td colspan=3 valign=bottom> <br> 20 <font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr> 21 22 <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> 23 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.internal.platform.tracing_agent.chrome_tracing_agent.html">chrome_tracing_agent</a><br> 24 <a href="telemetry.internal.platform.tracing_agent.chrome_tracing_agent_unittest.html">chrome_tracing_agent_unittest</a><br> 25 </td><td width="25%" valign=top><a href="telemetry.internal.platform.tracing_agent.chrome_tracing_devtools_manager.html">chrome_tracing_devtools_manager</a><br> 26 <a href="telemetry.internal.platform.tracing_agent.display_tracing_agent.html">display_tracing_agent</a><br> 27 </td><td width="25%" valign=top><a href="telemetry.internal.platform.tracing_agent.display_tracing_agent_unittest.html">display_tracing_agent_unittest</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> <br> 32 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 33 34 <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </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.internal.platform.tracing_agent.html#TracingAgent">TracingAgent</a> 40 </font></dt></dl> 41 </dd> 42 </dl> 43 <p> 44 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 45 <tr bgcolor="#ffc8d8"> 46 <td colspan=3 valign=bottom> <br> 47 <font color="#000000" face="helvetica, arial"><a name="TracingAgent">class <strong>TracingAgent</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> 48 49 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> 50 <td colspan=2><tt>A tracing agent provided by the platform.<br> 51 <br> 52 A tracing agent can gather data with <a href="#TracingAgent-Start">Start</a>() until <a href="#TracingAgent-Stop">Stop</a>().<br> 53 Before constructing an <a href="#TracingAgent">TracingAgent</a>, check whether it's supported on the<br> 54 platform with IsSupported method first.<br> 55 <br> 56 NOTE: All subclasses of <a href="#TracingAgent">TracingAgent</a> must not change the constructor's<br> 57 parameters so the agents can be dynamically constructed in<br> 58 tracing_controller_backend.<br> </tt></td></tr> 59 <tr><td> </td> 60 <td width="100%">Methods defined here:<br> 61 <dl><dt><a name="TracingAgent-Start"><strong>Start</strong></a>(self, trace_options, category_filter, timeout)</dt><dd><tt>Override to add tracing agent's custom logic to start tracing.<br> 62 <br> 63 Depending on trace_options and category_filter, the tracing agent may choose<br> 64 to start or not start tracing.<br> 65 <br> 66 Args:<br> 67 trace_options: an instance of tracing_options.TracingOptions that<br> 68 control which core tracing systems should be enabled.<br> 69 category_filter: an instance of<br> 70 tracing_category_filter.TracingCategoryFilter<br> 71 timeout: number of seconds that this tracing agent should try to start<br> 72 tracing until time out.<br> 73 <br> 74 Returns:<br> 75 True if tracing agent started succesfully.</tt></dd></dl> 76 77 <dl><dt><a name="TracingAgent-Stop"><strong>Stop</strong></a>(self, trace_data_builder)</dt><dd><tt>Override to add tracing agent's custom logic to stop tracing.<br> 78 <br> 79 <a href="#TracingAgent-Stop">Stop</a>() should guarantee tracing is stopped, even if there may be exception.</tt></dd></dl> 80 81 <dl><dt><a name="TracingAgent-__init__"><strong>__init__</strong></a>(self, platform_backend)</dt></dl> 82 83 <hr> 84 Class methods defined here:<br> 85 <dl><dt><a name="TracingAgent-IsSupported"><strong>IsSupported</strong></a>(cls, _platform_backend)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> 86 87 <hr> 88 Data descriptors defined here:<br> 89 <dl><dt><strong>__dict__</strong></dt> 90 <dd><tt>dictionary for instance variables (if defined)</tt></dd> 91 </dl> 92 <dl><dt><strong>__weakref__</strong></dt> 93 <dd><tt>list of weak references to the object (if defined)</tt></dd> 94 </dl> 95 </td></tr></table></td></tr></table> 96 </body></html>
