1 2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3 <html><head><title>Python: module telemetry.timeline.thread</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.timeline.html"><font color="#ffffff">timeline</font></a>.thread</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/timeline/thread.py">telemetry/timeline/thread.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>Modules</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.timeline.async_slice.html">telemetry.timeline.async_slice</a><br> 24 <a href="telemetry.timeline.event_container.html">telemetry.timeline.event_container</a><br> 25 </td><td width="25%" valign=top><a href="telemetry.timeline.flow_event.html">telemetry.timeline.flow_event</a><br> 26 <a href="telemetry.timeline.sample.html">telemetry.timeline.sample</a><br> 27 </td><td width="25%" valign=top><a href="telemetry.timeline.slice.html">telemetry.timeline.slice</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="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</a>(<a href="__builtin__.html#object">__builtin__.object</a>) 37 </font></dt><dd> 38 <dl> 39 <dt><font face="helvetica, arial"><a href="telemetry.timeline.thread.html#Thread">Thread</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="Thread">class <strong>Thread</strong></a>(<a href="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</a>)</font></td></tr> 48 49 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> 50 <td colspan=2><tt>A <a href="#Thread">Thread</a> stores all the trace events collected for a particular<br> 51 thread. We organize the synchronous slices on a thread by "subrows," where<br> 52 subrow 0 has all the root slices, subrow 1 those nested 1 deep, and so on.<br> 53 The asynchronous slices are stored in an AsyncSliceGroup object.<br> </tt></td></tr> 54 <tr><td> </td> 55 <td width="100%"><dl><dt>Method resolution order:</dt> 56 <dd><a href="telemetry.timeline.thread.html#Thread">Thread</a></dd> 57 <dd><a href="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</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="Thread-AddAsyncSlice"><strong>AddAsyncSlice</strong></a>(self, async_slice)</dt></dl> 63 64 <dl><dt><a name="Thread-AddFlowEvent"><strong>AddFlowEvent</strong></a>(self, flow_event)</dt></dl> 65 66 <dl><dt><a name="Thread-AddSample"><strong>AddSample</strong></a>(self, category, name, timestamp, args<font color="#909090">=None</font>)</dt></dl> 67 68 <dl><dt><a name="Thread-AutoCloseOpenSlices"><strong>AutoCloseOpenSlices</strong></a>(self, max_timestamp, max_thread_timestamp)</dt></dl> 69 70 <dl><dt><a name="Thread-BeginSlice"><strong>BeginSlice</strong></a>(self, category, name, timestamp, thread_timestamp<font color="#909090">=None</font>, args<font color="#909090">=None</font>)</dt><dd><tt>Opens a new slice for the thread.<br> 71 Calls to beginSlice and endSlice must be made with<br> 72 non-monotonically-decreasing timestamps.<br> 73 <br> 74 * category: Category to which the slice belongs.<br> 75 * name: Name of the slice to add.<br> 76 * timestamp: The timetsamp of the slice, in milliseconds.<br> 77 * thread_timestamp: <a href="#Thread">Thread</a> specific clock (scheduled) timestamp of the<br> 78 slice, in milliseconds.<br> 79 * args: Arguments associated with<br> 80 <br> 81 Returns newly opened slice</tt></dd></dl> 82 83 <dl><dt><a name="Thread-EndSlice"><strong>EndSlice</strong></a>(self, end_timestamp, end_thread_timestamp<font color="#909090">=None</font>)</dt><dd><tt>Ends the last begun slice in this group and pushes it onto the slice<br> 84 array.<br> 85 <br> 86 * end_timestamp: Timestamp when the slice ended in milliseconds<br> 87 * end_thread_timestamp: Timestamp when the scheduled time of the slice ended<br> 88 in milliseconds<br> 89 <br> 90 returns completed slice.</tt></dd></dl> 91 92 <dl><dt><a name="Thread-FinalizeImport"><strong>FinalizeImport</strong></a>(self)</dt></dl> 93 94 <dl><dt><a name="Thread-IsTimestampValidForBeginOrEnd"><strong>IsTimestampValidForBeginOrEnd</strong></a>(self, timestamp)</dt></dl> 95 96 <dl><dt><a name="Thread-IterChildContainers"><strong>IterChildContainers</strong></a>(self)</dt></dl> 97 98 <dl><dt><a name="Thread-IterEventsInThisContainer"><strong>IterEventsInThisContainer</strong></a>(self, event_type_predicate, event_predicate)</dt></dl> 99 100 <dl><dt><a name="Thread-PushCompleteSlice"><strong>PushCompleteSlice</strong></a>(self, category, name, timestamp, duration, thread_timestamp, thread_duration, args<font color="#909090">=None</font>)</dt></dl> 101 102 <dl><dt><a name="Thread-PushSlice"><strong>PushSlice</strong></a>(self, new_slice)</dt></dl> 103 104 <dl><dt><a name="Thread-__init__"><strong>__init__</strong></a>(self, process, tid)</dt></dl> 105 106 <hr> 107 Data descriptors defined here:<br> 108 <dl><dt><strong>all_slices</strong></dt> 109 </dl> 110 <dl><dt><strong>async_slices</strong></dt> 111 </dl> 112 <dl><dt><strong>open_slice_count</strong></dt> 113 </dl> 114 <dl><dt><strong>samples</strong></dt> 115 </dl> 116 <dl><dt><strong>toplevel_slices</strong></dt> 117 </dl> 118 <hr> 119 Methods inherited from <a href="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</a>:<br> 120 <dl><dt><a name="Thread-GetAllEvents"><strong>GetAllEvents</strong></a>(self, recursive<font color="#909090">=True</font>)</dt><dd><tt># List versions. These should always be simple expressions that list() on<br> 121 # an underlying iter method.</tt></dd></dl> 122 123 <dl><dt><a name="Thread-GetAllEventsOfName"><strong>GetAllEventsOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 124 125 <dl><dt><a name="Thread-GetAllToplevelSlicesOfName"><strong>GetAllToplevelSlicesOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 126 127 <dl><dt><a name="Thread-IterAllAsyncSlicesOfName"><strong>IterAllAsyncSlicesOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 128 129 <dl><dt><a name="Thread-IterAllAsyncSlicesStartsWithName"><strong>IterAllAsyncSlicesStartsWithName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 130 131 <dl><dt><a name="Thread-IterAllEvents"><strong>IterAllEvents</strong></a>(self, recursive<font color="#909090">=True</font>, event_type_predicate<font color="#909090">=<function <lambda>></font>, event_predicate<font color="#909090">=<function <lambda>></font>)</dt><dd><tt>Iterates all events in this container, pre-filtered by two predicates.<br> 132 <br> 133 Only events with a type matching event_type_predicate AND matching event<br> 134 event_predicate will be yielded.<br> 135 <br> 136 event_type_predicate is given an actual type object, e.g.:<br> 137 event_type_predicate(slice_module.Slice)<br> 138 <br> 139 event_predicate is given actual events:<br> 140 event_predicate(thread.slices[7])</tt></dd></dl> 141 142 <dl><dt><a name="Thread-IterAllEventsOfName"><strong>IterAllEventsOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt><dd><tt># Helper functions for finding common kinds of events. Must always take an<br> 143 # optinal recurisve parameter and be implemented in terms fo IterAllEvents.</tt></dd></dl> 144 145 <dl><dt><a name="Thread-IterAllFlowEvents"><strong>IterAllFlowEvents</strong></a>(self, recursive<font color="#909090">=True</font>)</dt></dl> 146 147 <dl><dt><a name="Thread-IterAllSlices"><strong>IterAllSlices</strong></a>(self, recursive<font color="#909090">=True</font>)</dt></dl> 148 149 <dl><dt><a name="Thread-IterAllSlicesInRange"><strong>IterAllSlicesInRange</strong></a>(self, start, end, recursive<font color="#909090">=True</font>)</dt></dl> 150 151 <dl><dt><a name="Thread-IterAllSlicesOfName"><strong>IterAllSlicesOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 152 153 <dl><dt><a name="Thread-IterAllToplevelSlicesOfName"><strong>IterAllToplevelSlicesOfName</strong></a>(self, name, recursive<font color="#909090">=True</font>)</dt></dl> 154 155 <hr> 156 Static methods inherited from <a href="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</a>:<br> 157 <dl><dt><a name="Thread-IsAsyncSlice"><strong>IsAsyncSlice</strong></a>(t)</dt></dl> 158 159 <hr> 160 Data descriptors inherited from <a href="telemetry.timeline.event_container.html#TimelineEventContainer">telemetry.timeline.event_container.TimelineEventContainer</a>:<br> 161 <dl><dt><strong>__dict__</strong></dt> 162 <dd><tt>dictionary for instance variables (if defined)</tt></dd> 163 </dl> 164 <dl><dt><strong>__weakref__</strong></dt> 165 <dd><tt>list of weak references to the object (if defined)</tt></dd> 166 </dl> 167 </td></tr></table></td></tr></table> 168 </body></html>
