diff options
Diffstat (limited to '.packages/microsoft.netcore.app.ref/3.0.0/ref/netcoreapp3.0/System.Threading.Timer.xml')
| -rwxr-xr-x | .packages/microsoft.netcore.app.ref/3.0.0/ref/netcoreapp3.0/System.Threading.Timer.xml | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/.packages/microsoft.netcore.app.ref/3.0.0/ref/netcoreapp3.0/System.Threading.Timer.xml b/.packages/microsoft.netcore.app.ref/3.0.0/ref/netcoreapp3.0/System.Threading.Timer.xml new file mode 100755 index 0000000000..442a0181c0 --- /dev/null +++ b/.packages/microsoft.netcore.app.ref/3.0.0/ref/netcoreapp3.0/System.Threading.Timer.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="utf-8"?> +<doc> + <assembly> + <name>System.Threading.Timer</name> + </assembly> + <members> + <member name="T:System.Threading.Timer"> + <summary>Provides a mechanism for executing a method on a thread pool thread at specified intervals. This class cannot be inherited.</summary> + </member> + <member name="M:System.Threading.Timer.#ctor(System.Threading.TimerCallback)"> + <summary>Initializes a new instance of the <see cref="T:System.Threading.Timer" /> class with an infinite period and an infinite due time, using the newly created <see cref="T:System.Threading.Timer" /> object as the state object.</summary> + <param name="callback">A <see cref="T:System.Threading.TimerCallback" /> delegate representing a method to be executed.</param> + </member> + <member name="M:System.Threading.Timer.#ctor(System.Threading.TimerCallback,System.Object,System.Int32,System.Int32)"> + <summary>Initializes a new instance of the <see langword="Timer" /> class, using a 32-bit signed integer to specify the time interval.</summary> + <param name="callback">A <see cref="T:System.Threading.TimerCallback" /> delegate representing a method to be executed.</param> + <param name="state">An object containing information to be used by the callback method, or <see langword="null" />.</param> + <param name="dueTime">The amount of time to delay before <paramref name="callback" /> is invoked, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to prevent the timer from starting. Specify zero (0) to start the timer immediately.</param> + <param name="period">The time interval between invocations of <paramref name="callback" />, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to disable periodic signaling.</param> + <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime" /> or <paramref name="period" /> parameter is negative and is not equal to <see cref="F:System.Threading.Timeout.Infinite" />.</exception> + <exception cref="T:System.ArgumentNullException">The <paramref name="callback" /> parameter is <see langword="null" />.</exception> + </member> + <member name="M:System.Threading.Timer.#ctor(System.Threading.TimerCallback,System.Object,System.Int64,System.Int64)"> + <summary>Initializes a new instance of the <see langword="Timer" /> class, using 64-bit signed integers to measure time intervals.</summary> + <param name="callback">A <see cref="T:System.Threading.TimerCallback" /> delegate representing a method to be executed.</param> + <param name="state">An object containing information to be used by the callback method, or <see langword="null" />.</param> + <param name="dueTime">The amount of time to delay before <paramref name="callback" /> is invoked, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to prevent the timer from starting. Specify zero (0) to start the timer immediately.</param> + <param name="period">The time interval between invocations of <paramref name="callback" />, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to disable periodic signaling.</param> + <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime" /> or <paramref name="period" /> parameter is negative and is not equal to <see cref="F:System.Threading.Timeout.Infinite" />.</exception> + <exception cref="T:System.NotSupportedException">The <paramref name="dueTime" /> or <paramref name="period" /> parameter is greater than 4294967294.</exception> + </member> + <member name="M:System.Threading.Timer.#ctor(System.Threading.TimerCallback,System.Object,System.TimeSpan,System.TimeSpan)"> + <summary>Initializes a new instance of the <see langword="Timer" /> class, using <see cref="T:System.TimeSpan" /> values to measure time intervals.</summary> + <param name="callback">A delegate representing a method to be executed.</param> + <param name="state">An object containing information to be used by the callback method, or <see langword="null" />.</param> + <param name="dueTime">The amount of time to delay before the <paramref name="callback" /> parameter invokes its methods. Specify negative one (-1) milliseconds to prevent the timer from starting. Specify zero (0) to start the timer immediately.</param> + <param name="period">The time interval between invocations of the methods referenced by <paramref name="callback" />. Specify negative one (-1) milliseconds to disable periodic signaling.</param> + <exception cref="T:System.ArgumentOutOfRangeException">The number of milliseconds in the value of <paramref name="dueTime" /> or <paramref name="period" /> is negative and not equal to <see cref="F:System.Threading.Timeout.Infinite" />, or is greater than <see cref="F:System.Int32.MaxValue" />.</exception> + <exception cref="T:System.ArgumentNullException">The <paramref name="callback" /> parameter is <see langword="null" />.</exception> + </member> + <member name="M:System.Threading.Timer.#ctor(System.Threading.TimerCallback,System.Object,System.UInt32,System.UInt32)"> + <summary>Initializes a new instance of the <see langword="Timer" /> class, using 32-bit unsigned integers to measure time intervals.</summary> + <param name="callback">A delegate representing a method to be executed.</param> + <param name="state">An object containing information to be used by the callback method, or <see langword="null" />.</param> + <param name="dueTime">The amount of time to delay before <paramref name="callback" /> is invoked, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to prevent the timer from starting. Specify zero (0) to start the timer immediately.</param> + <param name="period">The time interval between invocations of <paramref name="callback" />, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to disable periodic signaling.</param> + <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime" /> or <paramref name="period" /> parameter is negative and is not equal to <see cref="F:System.Threading.Timeout.Infinite" />.</exception> + <exception cref="T:System.ArgumentNullException">The <paramref name="callback" /> parameter is <see langword="null" />.</exception> + </member> + <member name="P:System.Threading.Timer.ActiveCount"> + <summary>Gets the number of timers that are currently active. An active timer is registered to tick at some point in the future, and has not yet been canceled.</summary> + <returns>The number of timers that are currently active.</returns> + </member> + <member name="M:System.Threading.Timer.Change(System.Int32,System.Int32)"> + <summary>Changes the start time and the interval between method invocations for a timer, using 32-bit signed integers to measure time intervals.</summary> + <param name="dueTime">The amount of time to delay before the invoking the callback method specified when the <see cref="T:System.Threading.Timer" /> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to prevent the timer from restarting. Specify zero (0) to restart the timer immediately.</param> + <param name="period">The time interval between invocations of the callback method specified when the <see cref="T:System.Threading.Timer" /> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to disable periodic signaling.</param> + <returns> + <see langword="true" /> if the timer was successfully updated; otherwise, <see langword="false" />.</returns> + <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.Timer" /> has already been disposed.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime" /> or <paramref name="period" /> parameter is negative and is not equal to <see cref="F:System.Threading.Timeout.Infinite" />.</exception> + </member> + <member name="M:System.Threading.Timer.Change(System.Int64,System.Int64)"> + <summary>Changes the start time and the interval between method invocations for a timer, using 64-bit signed integers to measure time intervals.</summary> + <param name="dueTime">The amount of time to delay before the invoking the callback method specified when the <see cref="T:System.Threading.Timer" /> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to prevent the timer from restarting. Specify zero (0) to restart the timer immediately.</param> + <param name="period">The time interval between invocations of the callback method specified when the <see cref="T:System.Threading.Timer" /> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to disable periodic signaling.</param> + <returns> + <see langword="true" /> if the timer was successfully updated; otherwise, <see langword="false" />.</returns> + <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.Timer" /> has already been disposed.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime" /> or <paramref name="period" /> parameter is less than -1.</exception> + <exception cref="T:System.NotSupportedException">The <paramref name="dueTime" /> or <paramref name="period" /> parameter is greater than 4294967294.</exception> + </member> + <member name="M:System.Threading.Timer.Change(System.TimeSpan,System.TimeSpan)"> + <summary>Changes the start time and the interval between method invocations for a timer, using <see cref="T:System.TimeSpan" /> values to measure time intervals.</summary> + <param name="dueTime">A <see cref="T:System.TimeSpan" /> representing the amount of time to delay before invoking the callback method specified when the <see cref="T:System.Threading.Timer" /> was constructed. Specify negative one (-1) milliseconds to prevent the timer from restarting. Specify zero (0) to restart the timer immediately.</param> + <param name="period">The time interval between invocations of the callback method specified when the <see cref="T:System.Threading.Timer" /> was constructed. Specify negative one (-1) milliseconds to disable periodic signaling.</param> + <returns> + <see langword="true" /> if the timer was successfully updated; otherwise, <see langword="false" />.</returns> + <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.Timer" /> has already been disposed.</exception> + <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime" /> or <paramref name="period" /> parameter, in milliseconds, is less than -1.</exception> + <exception cref="T:System.NotSupportedException">The <paramref name="dueTime" /> or <paramref name="period" /> parameter, in milliseconds, is greater than 4294967294.</exception> + </member> + <member name="M:System.Threading.Timer.Change(System.UInt32,System.UInt32)"> + <summary>Changes the start time and the interval between method invocations for a timer, using 32-bit unsigned integers to measure time intervals.</summary> + <param name="dueTime">The amount of time to delay before the invoking the callback method specified when the <see cref="T:System.Threading.Timer" /> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to prevent the timer from restarting. Specify zero (0) to restart the timer immediately.</param> + <param name="period">The time interval between invocations of the callback method specified when the <see cref="T:System.Threading.Timer" /> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite" /> to disable periodic signaling.</param> + <returns> + <see langword="true" /> if the timer was successfully updated; otherwise, <see langword="false" />.</returns> + <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.Timer" /> has already been disposed.</exception> + </member> + <member name="M:System.Threading.Timer.Dispose"> + <summary>Releases all resources used by the current instance of <see cref="T:System.Threading.Timer" />.</summary> + </member> + <member name="M:System.Threading.Timer.Dispose(System.Threading.WaitHandle)"> + <summary>Releases all resources used by the current instance of <see cref="T:System.Threading.Timer" /> and signals when the timer has been disposed of.</summary> + <param name="notifyObject">The <see cref="T:System.Threading.WaitHandle" /> to be signaled when the <see langword="Timer" /> has been disposed of.</param> + <returns> + <see langword="true" /> if the function succeeds; otherwise, <see langword="false" />.</returns> + <exception cref="T:System.ArgumentNullException">The <paramref name="notifyObject" /> parameter is <see langword="null" />.</exception> + </member> + <member name="M:System.Threading.Timer.DisposeAsync"> + <summary>Releases all resources used by the current instance of <see cref="T:System.Threading.Timer" />.</summary> + <returns>A <see cref="T:System.Threading.Tasks.ValueTask" /> that completes when all work associated with the timer has ceased.</returns> + </member> + <member name="T:System.Threading.TimerCallback"> + <summary>Represents the method that handles calls from a <see cref="T:System.Threading.Timer" />.</summary> + <param name="state">An object containing application-specific information relevant to the method invoked by this delegate, or <see langword="null" />.</param> + </member> + </members> +</doc>
\ No newline at end of file |