tools/telemetry/docs/telemetry.core.timeline.thread.html - Issue 19772005: [telemetry] Timeline model cleanups

Side by Side Diff: tools/telemetry/docs/telemetry.core.timeline.thread.html

Issue 19772005: [telemetry] Timeline model cleanups (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 7 years, 5 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

« no previous file with comments | « tools/telemetry/docs/telemetry.core.timeline.slice.html ('k') | tools/telemetry/docs/telemetry.core.timeline.trace_event_importer.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
1	1

2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">	2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

3 <html><head><title>Python: module telemetry.core.timeline.tracing.thread</title>	3 <html><head><title>Python: module telemetry.core.timeline.thread</title>

4 </head><body bgcolor="#f0f0f8">	4 </head><body bgcolor="#f0f0f8">

5	5

6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">	6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">

7 <tr bgcolor="#7799ee">	7 <tr bgcolor="#7799ee">

8 <td valign=bottom> <br>	8 <td valign=bottom> <br>

9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .core.html"><font color="#ffffff">core</font></a>.<a href="telemetry.core.timeli ne.html"><font color="#ffffff">timeline</font></a>.<a href="telemetry.core.timel ine.tracing.html"><font color="#ffffff">tracing</font></a>.thread</strong></big> </big></font></td	9 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a hre f="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry .core.html"><font color="#ffffff">core</font></a>.<a href="telemetry.core.timeli ne.html"><font color="#ffffff">timeline</font></a>.thread</strong></big></big></ font></td

10 ><td align=right valign=bottom	10 ><td align=right valign=bottom

11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/core/timeline/tracing/thread.py">telemetry/core/timeline/tracing/t hread.py</a></font></td></tr></table>	11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href= "../telemetry/core/timeline/thread.py">telemetry/core/timeline/thread.py</a></fo nt></td></tr></table>

12 <p><tt># Copyright 2013 The Chromium Authors.  All rights reserved.<br>	12 <p><tt># Copyright 2013 The Chromium Authors.  All rights reserved.<br>

13 # Use of this source code is governed by  a BSD-style license that can be<br>	13 # Use of this source code is governed by  a BSD-style license that can be<br>

14 # found in the LICENSE file.</tt></p>	14 # found in the LICENSE file.</tt></p>

15 <p>	15 <p>

16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	16 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

17 <tr bgcolor="#aa55cc">	17 <tr bgcolor="#aa55cc">

18 <td colspan=3 valign=bottom> <br>	18 <td colspan=3 valign=bottom> <br>

19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>	19 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big ></font></td></tr>

20	20

21 <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td>  </td>	21 <tr><td bgcolor="#aa55cc"><tt>      </tt></td><td>  </td>

22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.timeline.event.html">telemetry.core.timeline.event</a ><br>	22 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=t op><a href="telemetry.core.timeline.event_container.html">telemetry.core.timelin e.event_container</a><br>

23 </td><td width="25%" valign=top><a href="telemetry.core.timeline.tracing.sample. html">telemetry.core.timeline.tracing.sample</a><br>	23 </td><td width="25%" valign=top><a href="telemetry.core.timeline.sample.html">te lemetry.core.timeline.sample</a><br>

24 </td><td width="25%" valign=top><a href="telemetry.core.timeline.tracing.slice.h tml">telemetry.core.timeline.tracing.slice</a><br>	24 </td><td width="25%" valign=top><a href="telemetry.core.timeline.slice.html">tel emetry.core.timeline.slice</a><br>

25 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>	25 </td><td width="25%" valign=top></td></tr></table></td></tr></table><p>

26 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	26 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

27 <tr bgcolor="#ee77aa">	27 <tr bgcolor="#ee77aa">

28 <td colspan=3 valign=bottom> <br>	28 <td colspan=3 valign=bottom> <br>

29 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>	29 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big ></font></td></tr>

30	30

31 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>	31 <tr><td bgcolor="#ee77aa"><tt>      </tt></td><td>  </td>

32 <td width="100%"><dl>	32 <td width="100%"><dl>

33 <dt><font face="helvetica, arial"><a href="telemetry.core.timeline.event.html#Ti melineEvent">telemetry.core.timeline.event.TimelineEvent</a>(<a href="__builtin_ _.html#object">__builtin__.object</a>)	33 <dt><font face="helvetica, arial"><a href="telemetry.core.timeline.event_contain er.html#TimelineEventContainer">telemetry.core.timeline.event_container.Timeline EventContainer</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

34 </font></dt><dd>	34 </font></dt><dd>

35 <dl>	35 <dl>

36 <dt><font face="helvetica, arial"><a href="telemetry.core.timeline.tracing.threa d.html#Thread">Thread</a>	36 <dt><font face="helvetica, arial"><a href="telemetry.core.timeline.thread.html#T hread">Thread</a>

37 </font></dt></dl>	37 </font></dt></dl>

38 </dd>	38 </dd>

39 </dl>	39 </dl>

40 <p>	40 <p>

41 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">	41 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

42 <tr bgcolor="#ffc8d8">	42 <tr bgcolor="#ffc8d8">

43 <td colspan=3 valign=bottom> <br>	43 <td colspan=3 valign=bottom> <br>

44 <font color="#000000" face="helvetica, arial"><a name="Thread">class <strong>Thr ead</strong></a>(<a href="telemetry.core.timeline.event.html#TimelineEvent">tele metry.core.timeline.event.TimelineEvent</a>)</font></td></tr>	44 <font color="#000000" face="helvetica, arial"><a name="Thread">class <strong>Thr ead</strong></a>(<a href="telemetry.core.timeline.event_container.html#TimelineE ventContainer">telemetry.core.timeline.event_container.TimelineEventContainer</a >)</font></td></tr>

45	45

46 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>	46 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

47 <td colspan=2><tt>A <a href="#Thread">Thread</a> stores all  the trace events collected for a particular<br>	47 <td colspan=2><tt>A <a href="#Thread">Thread</a> stores all  the trace events collected for a particular<br>

48 thread. We organize the synchronous slices on&nbsp ;a thread by "subrows," where<br>	48 thread. We organize the synchronous slices on&nbsp ;a thread by "subrows," where<br>

49 subrow 0 has all the root slices, subrow&nbsp ;1 those nested 1 deep, and so on.<br>	49 subrow 0 has all the root slices, subrow&nbsp ;1 those nested 1 deep, and so on.<br>

50 The asynchronous slices are stored in an Asyn cSliceGroup object.<br> </tt></td></tr>	50 The asynchronous slices are stored in an Asyn cSliceGroup object.<br> </tt></td></tr>

51 <tr><td> </td>	51 <tr><td> </td>

52 <td width="100%"><dl><dt>Method resolution order:</dt>	52 <td width="100%"><dl><dt>Method resolution order:</dt>

53 <dd><a href="telemetry.core.timeline.tracing.thread.html#Thread">Thread</a></dd>	53 <dd><a href="telemetry.core.timeline.thread.html#Thread">Thread</a></dd>

54 <dd><a href="telemetry.core.timeline.event.html#TimelineEvent">telemetry.core.ti meline.event.TimelineEvent</a></dd>	54 <dd><a href="telemetry.core.timeline.event_container.html#TimelineEventContainer ">telemetry.core.timeline.event_container.TimelineEventContainer</a></dd>

55 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>	55 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

56 </dl>	56 </dl>

57 <hr>	57 <hr>

58 Methods defined here:<br>	58 Methods defined here:<br>

59 <dl><dt><a name="Thread-AddAsyncSlice"><strong>AddAsyncSlice</strong></a>(self, async_slice)</dt></dl>	59 <dl><dt><a name="Thread-AddAsyncSlice"><strong>AddAsyncSlice</strong></a>(self, async_slice)</dt></dl>

60	60

61 <dl><dt><a name="Thread-AddSample"><strong>AddSample</strong></a>(self, category , name, timestamp, args<font color="#909090">=None</font>)</dt></dl>	61 <dl><dt><a name="Thread-AddSample"><strong>AddSample</strong></a>(self, category , name, timestamp, args<font color="#909090">=None</font>)</dt></dl>

62	62

63 <dl><dt><a name="Thread-AutoCloseOpenSlices"><strong>AutoCloseOpenSlices</strong ></a>(self, max_timestamp<font color="#909090">=None</font>)</dt></dl>	63 <dl><dt><a name="Thread-AutoCloseOpenSlices"><strong>AutoCloseOpenSlices</strong ></a>(self, max_timestamp)</dt></dl>

64	64

65 <dl><dt><a name="Thread-BeginSlice"><strong>BeginSlice</strong></a>(self, catego ry, name, timestamp, args<font color="#909090">=None</font>)</dt><dd><tt>Opens&n bsp;a new slice for the thread.<br>	65 <dl><dt><a name="Thread-BeginSlice"><strong>BeginSlice</strong></a>(self, catego ry, name, timestamp, args<font color="#909090">=None</font>)</dt><dd><tt>Opens&n bsp;a new slice for the thread.<br>

66 Calls to beginSlice and endSlice must be made  with<br>	66 Calls to beginSlice and endSlice must be made  with<br>

67 non-monotonically-decreasing timestamps.<br>	67 non-monotonically-decreasing timestamps.<br>

68  <br>	68  <br>

69 * category: Category to which the slice belon gs.<br>	69 * category: Category to which the slice belon gs.<br>

70 * name: Name of the slice to add.<br>	70 * name: Name of the slice to add.<br>

71 * timestamp: The timetsamp of the slice, in&n bsp;milliseconds.<br>	71 * timestamp: The timetsamp of the slice, in&n bsp;milliseconds.<br>

72 * args: Arguments associated with<br>	72 * args: Arguments associated with<br>

73  <br>	73  <br>

74 Returns newly opened slice</tt></dd></dl>	74 Returns newly opened slice</tt></dd></dl>

75	75

76 <dl><dt><a name="Thread-EndSlice"><strong>EndSlice</strong></a>(self, end_timest amp)</dt><dd><tt>Ends the last begun slice in this  group and pushes it onto the slice<br>	76 <dl><dt><a name="Thread-EndSlice"><strong>EndSlice</strong></a>(self, end_timest amp)</dt><dd><tt>Ends the last begun slice in this  group and pushes it onto the slice<br>

77 array.<br>	77 array.<br>

78  <br>	78  <br>

79 * end_timestamp: Timestamp when the slice ended&nb sp;in milliseconds<br>	79 * end_timestamp: Timestamp when the slice ended&nb sp;in milliseconds<br>

80  <br>	80  <br>

81 returns completed slice.</tt></dd></dl>	81 returns completed slice.</tt></dd></dl>

82	82

83 <dl><dt><a name="Thread-FinalizeImport"><strong>FinalizeImport</strong></a>(self )</dt></dl>	83 <dl><dt><a name="Thread-FinalizeImport"><strong>FinalizeImport</strong></a>(self )</dt></dl>

84	84

85 <dl><dt><a name="Thread-IsTimestampValidForBeginOrEnd"><strong>IsTimestampValidF orBeginOrEnd</strong></a>(self, timestamp)</dt></dl>	85 <dl><dt><a name="Thread-IsTimestampValidForBeginOrEnd"><strong>IsTimestampValidF orBeginOrEnd</strong></a>(self, timestamp)</dt></dl>

86	86

	87 <dl><dt><a name="Thread-IterAllSlices"><strong>IterAllSlices</strong></a>(self)< /dt></dl>

	88

	89 <dl><dt><a name="Thread-IterChildContainers"><strong>IterChildContainers</strong ></a>(self)</dt></dl>

	90

	91 <dl><dt><a name="Thread-IterEventsInThisContainer"><strong>IterEventsInThisConta iner</strong></a>(self)</dt></dl>

	92

87 <dl><dt><a name="Thread-PushSlice"><strong>PushSlice</strong></a>(self, new_slic e)</dt></dl>	93 <dl><dt><a name="Thread-PushSlice"><strong>PushSlice</strong></a>(self, new_slic e)</dt></dl>

88	94

89 <dl><dt><a name="Thread-UpdateBounds"><strong>UpdateBounds</strong></a>(self)</d t></dl>

90

91 <dl><dt><a name="Thread-__init__"><strong>__init__</strong></a>(self, process, t id)</dt></dl>	95 <dl><dt><a name="Thread-__init__"><strong>__init__</strong></a>(self, process, t id)</dt></dl>

92	96

93 <hr>	97 <hr>

94 Data descriptors defined here:<br>	98 Data descriptors defined here:<br>

	99 <dl><dt><strong>all_slices</strong></dt>

	100 </dl>

95 <dl><dt><strong>async_slices</strong></dt>	101 <dl><dt><strong>async_slices</strong></dt>

96 </dl>	102 </dl>

97 <dl><dt><strong>open_slice_count</strong></dt>	103 <dl><dt><strong>open_slice_count</strong></dt>

98 </dl>	104 </dl>

99 <dl><dt><strong>samples</strong></dt>	105 <dl><dt><strong>samples</strong></dt>

100 </dl>	106 </dl>

101 <dl><dt><strong>slices</strong></dt>	107 <dl><dt><strong>toplevel_slices</strong></dt>

102 </dl>	108 </dl>

103 <hr>	109 <hr>

104 Methods inherited from <a href="telemetry.core.timeline.event.html#TimelineEvent ">telemetry.core.timeline.event.TimelineEvent</a>:<br>	110 Data descriptors inherited from <a href="telemetry.core.timeline.event_container .html#TimelineEventContainer">telemetry.core.timeline.event_container.TimelineEv entContainer</a>:<br>

105 <dl><dt><a name="Thread-GetAllChildrenRecursive"><strong>GetAllChildrenRecursive </strong></a>(self, include_self<font color="#909090">=False</font>)</dt></dl>

106

107 <dl><dt><a name="Thread-ShiftTimestampsForward"><strong>ShiftTimestampsForward</ strong></a>(self, delta_time)</dt><dd><tt>Shifts start time of&nb sp;event by delta_time and also<br>

108 recursively shifts child events.</tt></dd></dl>

109

110 <dl><dt><a name="Thread-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>

111

112 <hr>

113 Data descriptors inherited from <a href="telemetry.core.timeline.event.html#Time lineEvent">telemetry.core.timeline.event.TimelineEvent</a>:<br>

114 <dl><dt><strong>__dict__</strong></dt>	111 <dl><dt><strong>__dict__</strong></dt>

115 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>	112 <dd><tt>dictionary for instance variables (if defined)< /tt></dd>

116 </dl>	113 </dl>

117 <dl><dt><strong>__weakref__</strong></dt>	114 <dl><dt><strong>__weakref__</strong></dt>

118 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>	115 <dd><tt>list of weak references to the object&nbsp ;(if defined)</tt></dd>

119 </dl>	116 </dl>

120 <dl><dt><strong>end</strong></dt>

121 </dl>

122 <dl><dt><strong>self_time</strong></dt>

123 <dd><tt>Time spent in this function less any  time spent in child events.</tt></dd>

124 </dl>

125 </td></tr></table></td></tr></table>	117 </td></tr></table></td></tr></table>

126 </body></html>	118 </body></html>

OLD	NEW