-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathPeriodicTimer.xml
218 lines (208 loc) · 13.9 KB
/
PeriodicTimer.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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
<Type Name="PeriodicTimer" FullName="System.Threading.PeriodicTimer">
<TypeSignature Language="C#" Value="public sealed class PeriodicTimer : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit PeriodicTimer extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:System.Threading.PeriodicTimer" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class PeriodicTimer
Implements IDisposable" />
<TypeSignature Language="F#" Value="type PeriodicTimer = class
 interface IDisposable" />
<TypeSignature Language="C++ CLI" Value="public ref class PeriodicTimer sealed : IDisposable" />
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Provides a periodic timer that enables waiting asynchronously for timer ticks.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This timer is intended to be used only by a single consumer at a time: only one call to <xref:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)> may be in flight at any given moment.
<xref:System.Threading.PeriodicTimer.Dispose> may be used concurrently with an active <xref:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)> to interrupt it and cause it to return `false`.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PeriodicTimer (TimeSpan period);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan period) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.PeriodicTimer.#ctor(System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (period As TimeSpan)" />
<MemberSignature Language="F#" Value="new System.Threading.PeriodicTimer : TimeSpan -> System.Threading.PeriodicTimer" Usage="new System.Threading.PeriodicTimer period" />
<MemberSignature Language="C++ CLI" Value="public:
 PeriodicTimer(TimeSpan period);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="period" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="period">The time interval in milliseconds between invocations of the callback.</param>
<summary>Initializes the timer.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="period" /> is less than or equal to 0, or greater than or equal to <see cref="F:System.UInt32.MaxValue">UInt32.MaxValue</see>.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PeriodicTimer (TimeSpan period, TimeProvider timeProvider);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan period, class System.TimeProvider timeProvider) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.PeriodicTimer.#ctor(System.TimeSpan,System.TimeProvider)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (period As TimeSpan, timeProvider As TimeProvider)" />
<MemberSignature Language="F#" Value="new System.Threading.PeriodicTimer : TimeSpan * TimeProvider -> System.Threading.PeriodicTimer" Usage="new System.Threading.PeriodicTimer (period, timeProvider)" />
<MemberSignature Language="C++ CLI" Value="public:
 PeriodicTimer(TimeSpan period, TimeProvider ^ timeProvider);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="period" Type="System.TimeSpan" Index="0" FrameworkAlternate="net-10.0;net-8.0;net-9.0" />
<Parameter Name="timeProvider" Type="System.TimeProvider" Index="1" FrameworkAlternate="net-10.0;net-8.0;net-9.0" />
</Parameters>
<Docs>
<param name="period">The period between ticks.</param>
<param name="timeProvider">The <see cref="T:System.TimeProvider" /> used to interpret <paramref name="period" />.</param>
<summary>Initializes the timer.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="period" /> must be <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> or represent a number of milliseconds equal to or larger than 1 and smaller than <see cref="F:System.UInt32.MaxValue" />.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="timeProvider" /> is <see langword="null" />.</exception>
</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:System.Threading.PeriodicTimer.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="periodicTimer.Dispose " />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void Dispose();" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Stops the timer and releases the associated managed resources.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Threading.PeriodicTimer.Dispose> will cause an active wait with <xref:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)> to complete with a value of `false`. All subsequent <xref:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)> invocations will produce a value of `false`.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="~PeriodicTimer ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Finalize() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.PeriodicTimer.Finalize" />
<MemberSignature Language="VB.NET" Value="Finalize ()" />
<MemberSignature Language="F#" Value="override this.Finalize : unit -> unit" Usage="periodicTimer.Finalize " />
<MemberSignature Language="C++ CLI" Value="!PeriodicTimer ()" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Ensures that resources are freed and other cleanup operations are performed when the garbage collector reclaims the <see cref="T:System.Threading.PeriodicTimer" /> object.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Period">
<MemberSignature Language="C#" Value="public TimeSpan Period { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan Period" />
<MemberSignature Language="DocId" Value="P:System.Threading.PeriodicTimer.Period" />
<MemberSignature Language="VB.NET" Value="Public Property Period As TimeSpan" />
<MemberSignature Language="F#" Value="member this.Period : TimeSpan with get, set" Usage="System.Threading.PeriodicTimer.Period" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan Period { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the period between ticks.</summary>
<value>To be added.</value>
<remarks>All prior ticks of the timer, including any that may be waiting to be consumed by <see cref="M:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)" />, are unaffected by changes to <see cref="P:System.Threading.PeriodicTimer.Period" />. Setting <see cref="P:System.Threading.PeriodicTimer.Period" /> affects only and all subsequent times at which the timer will tick.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="value" /> must be <see cref="F:System.Threading.Timeout.InfiniteTimeSpan" /> or represent a number of milliseconds equal to or larger than 1 and smaller than <see cref="F:System.UInt32.MaxValue" />.</exception>
</Docs>
</Member>
<Member MemberName="WaitForNextTickAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.ValueTask<bool> WaitForNextTickAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance valuetype System.Threading.Tasks.ValueTask`1<bool> WaitForNextTickAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function WaitForNextTickAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.WaitForNextTickAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<bool>" Usage="periodicTimer.WaitForNextTickAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> for cancelling the asynchronous wait. If cancellation is requested, it affects only the single wait operation; the underlying timer continues firing.</param>
<summary>Waits for the next tick of the timer, or for the timer to be stopped.</summary>
<returns>A task that will be completed due to the timer firing, <see cref="M:System.Threading.PeriodicTimer.Dispose" /> being called to stop the timer, or cancellation being requested.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Threading.PeriodicTimer> behaves like an auto-reset event, in that multiple ticks are coalesced into a single tick if they occur between calls to <xref:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)>. Similarly, a call to <xref:System.Threading.PeriodicTimer.Dispose> will void any tick not yet consumed. <xref:System.Threading.PeriodicTimer.WaitForNextTickAsync(System.Threading.CancellationToken)> may only be used by one consumer at a time, and may be used concurrently with a single call to <xref:System.Threading.PeriodicTimer.Dispose>.
]]></format>
</remarks>
<exception cref="T:System.OperationCanceledException">The cancellation token was canceled. This exception is stored into the returned task.</exception>
</Docs>
</Member>
</Members>
</Type>