-
Notifications
You must be signed in to change notification settings - Fork 0
/
TimingLogger.xml
175 lines (174 loc) · 8.92 KB
/
TimingLogger.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<Type Name="TimingLogger" FullName="Android.Runtime.TimingLogger">
<TypeSignature Language="C#" Value="public class TimingLogger : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TimingLogger extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Android.Runtime.TimingLogger" />
<TypeSignature Language="F#" Value="type TimingLogger = class
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
A class which uses the native Xamarin.Android runtime to accurately measure (to the nanosecond level) time
spent executing a portion of code bracketed with calls to <see cref="M:Android.Runtime.TimingLogger.Start(System.String)" /> (or the constructor, by
default) and <see cref="M:Android.Runtime.TimingLogger.Stop(System.String)" />.
Timing messages are logged with the <c>Info</c> priority and the <c>monodroid-timing</c> tag in the
device's logcat buffer.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TimingLogger (string? startMessage = default, bool startImmediately = true);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string startMessage, bool startImmediately) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Runtime.TimingLogger.#ctor(System.String,System.Boolean)" />
<MemberSignature Language="F#" Value="new Android.Runtime.TimingLogger : string * bool -> Android.Runtime.TimingLogger" Usage="new Android.Runtime.TimingLogger (startMessage, startImmediately)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="startMessage" Type="System.String" />
<Parameter Name="startImmediately" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="startMessage">To be added.</param>
<param name="startImmediately">To be added.</param>
<summary>
Construct a TimeLogger instance and start measuring time immediately, if the <paramref name="startImmediately" /> parameter is left out or set to <c>true</c>. If the <paramref name="startMessage" /> is not <c>null</c> then the message is logged at the start.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Runtime.TimingLogger.Dispose" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="timingLogger.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Dispose of the current instance. <see cref="M:Android.Runtime.TimingLogger.Dispose" /> for more information.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected virtual void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Runtime.TimingLogger.Dispose(System.Boolean)" />
<MemberSignature Language="F#" Value="abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit" Usage="timingLogger.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">To be added.</param>
<summary>
Dispose of the current instance, stopping timing if necessary. Note that if timing is stopped
here, the log will contain the default message (<see cref="M:Android.Runtime.TimingLogger.Stop(System.String)" />)
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="~TimingLogger ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Runtime.TimingLogger.Finalize" />
<MemberSignature Language="F#" Value="override this.Finalize : unit -> unit" Usage="timingLogger.Finalize " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Start">
<MemberSignature Language="C#" Value="public void Start (string? startMessage = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Start(string startMessage) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Runtime.TimingLogger.Start(System.String)" />
<MemberSignature Language="F#" Value="member this.Start : string -> unit" Usage="timingLogger.Start startMessage" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="startMessage" Type="System.String" />
</Parameters>
<Docs>
<param name="startMessage">To be added.</param>
<summary>
Start measuring time. If <paramref name="startMessage" /> is provided (or if the constructor was
passed a message to use when starting) it will be output to the log, otherwise the measurement
start is silent. The method does anything only if no measurement is active.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Stop">
<MemberSignature Language="C#" Value="public void Stop (string stopMessage);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Stop(string stopMessage) cil managed" />
<MemberSignature Language="DocId" Value="M:Android.Runtime.TimingLogger.Stop(System.String)" />
<MemberSignature Language="F#" Value="member this.Stop : string -> unit" Usage="timingLogger.Stop stopMessage" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Mono.Android</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stopMessage" Type="System.String" />
</Parameters>
<Docs>
<param name="stopMessage">To be added.</param>
<summary>
Stop measuring time and log message specified in the <paramref name="stopMessage" /> parameter. If
message is not specified, the Xamarin.Android runtime will use the default message, <c>"Managed
Timing"</c>. Time is reported in the following format:
<para><c>stopMessage; elapsed: %lis:%lu::%lu</c></para><para>
The <c>elapsed</c> fields are defined as follows: <c>seconds:milliseconds::nanoseconds</c></para></summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>