pkg/build/tizen40/ref/System.Threading.Timer.xml

   1 <?xml version="1.0" encoding="utf-8"?><span>
   2 <doc>
   3   <assembly>
   4     <name>System.Threading.Timer</name>
   5   </assembly>
   6   <members>
   7     <member name="T:System.Threading.Timer">
   8       <summary>Provides a mechanism for executing a method on a thread pool thread at specified intervals. This class cannot be inherited.</summary>
   9     </member>
  10     <member name="M:System.Threading.Timer.#ctor(System.Threading.TimerCallback)">
  11       <summary>Initializes a new instance of the <see cref="T:System.Threading.Timer"></see> class with an infinite period and an infinite due time, using the newly created <see cref="T:System.Threading.Timer"></see> object as the state object.</summary>
  12       <param name="callback">A <see cref="T:System.Threading.TimerCallback"></see> delegate representing a method to be executed.</param>
  13     </member>
  14     <member name="M:System.Threading.Timer.#ctor(System.Threading.TimerCallback,System.Object,System.Int32,System.Int32)">
  15       <summary>Initializes a new instance of the Timer class, using a 32-bit signed integer to specify the time interval.</summary>
  16       <param name="callback">A <see cref="T:System.Threading.TimerCallback"></see> delegate representing a method to be executed.</param>
  17       <param name="state">An object containing information to be used by the callback method, or null.</param>
  18       <param name="dueTime">The amount of time to delay before callback is invoked, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to prevent the timer from starting. Specify zero (0) to start the timer immediately.</param>
  19       <param name="period">The time interval between invocations of callback, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to disable periodic signaling.</param>
  20       <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime">dueTime</paramref> or <paramref name="period">period</paramref> parameter is negative and is not equal to <see cref="F:System.Threading.Timeout.Infinite"></see>.</exception>
  21       <exception cref="T:System.ArgumentNullException">The <paramref name="callback">callback</paramref> parameter is null.</exception>
  22     </member>
  23     <member name="M:System.Threading.Timer.#ctor(System.Threading.TimerCallback,System.Object,System.Int64,System.Int64)">
  24       <summary>Initializes a new instance of the Timer class, using 64-bit signed integers to measure time intervals.</summary>
  25       <param name="callback">A <see cref="T:System.Threading.TimerCallback"></see> delegate representing a method to be executed.</param>
  26       <param name="state">An object containing information to be used by the callback method, or null.</param>
  27       <param name="dueTime">The amount of time to delay before callback is invoked, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to prevent the timer from starting. Specify zero (0) to start the timer immediately.</param>
  28       <param name="period">The time interval between invocations of callback, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to disable periodic signaling.</param>
  29       <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime">dueTime</paramref> or <paramref name="period">period</paramref> parameter is negative and is not equal to <see cref="F:System.Threading.Timeout.Infinite"></see>.</exception>
  30       <exception cref="T:System.NotSupportedException">The <paramref name="dueTime">dueTime</paramref> or <paramref name="period">period</paramref> parameter is greater than 4294967294.</exception>
  31     </member>
  32     <member name="M:System.Threading.Timer.#ctor(System.Threading.TimerCallback,System.Object,System.TimeSpan,System.TimeSpan)">
  33       <summary>Initializes a new instance of the Timer class, using <see cref="T:System.TimeSpan"></see> values to measure time intervals.</summary>
  34       <param name="callback">A delegate representing a method to be executed.</param>
  35       <param name="state">An object containing information to be used by the callback method, or null.</param>
  36       <param name="dueTime">The amount of time to delay before the 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>
  37       <param name="period">The time interval between invocations of the methods referenced by callback. Specify negative one (-1) milliseconds to disable periodic signaling.</param>
  38       <exception cref="T:System.ArgumentOutOfRangeException">The number of milliseconds in the value of <paramref name="dueTime">dueTime</paramref> or <paramref name="period">period</paramref> is negative and not equal to <see cref="F:System.Threading.Timeout.Infinite"></see>, or is greater than <see cref="F:System.Int32.MaxValue"></see>.</exception>
  39       <exception cref="T:System.ArgumentNullException">The <paramref name="callback">callback</paramref> parameter is null.</exception>
  40     </member>
  41     <member name="M:System.Threading.Timer.#ctor(System.Threading.TimerCallback,System.Object,System.UInt32,System.UInt32)">
  42       <summary>Initializes a new instance of the Timer class, using 32-bit unsigned integers to measure time intervals.</summary>
  43       <param name="callback">A delegate representing a method to be executed.</param>
  44       <param name="state">An object containing information to be used by the callback method, or null.</param>
  45       <param name="dueTime">The amount of time to delay before callback is invoked, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to prevent the timer from starting. Specify zero (0) to start the timer immediately.</param>
  46       <param name="period">The time interval between invocations of callback, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to disable periodic signaling.</param>
  47       <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime">dueTime</paramref> or <paramref name="period">period</paramref> parameter is negative and is not equal to <see cref="F:System.Threading.Timeout.Infinite"></see>.</exception>
  48       <exception cref="T:System.ArgumentNullException">The <paramref name="callback">callback</paramref> parameter is null.</exception>
  49     </member>
  50     <member name="M:System.Threading.Timer.Change(System.Int32,System.Int32)">
  51       <summary>Changes the start time and the interval between method invocations for a timer, using 32-bit signed integers to measure time intervals.</summary>
  52       <param name="dueTime">The amount of time to delay before the invoking the callback method specified when the <see cref="T:System.Threading.Timer"></see> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to prevent the timer from restarting. Specify zero (0) to restart the timer immediately.</param>
  53       <param name="period">The time interval between invocations of the callback method specified when the <see cref="T:System.Threading.Timer"></see> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to disable periodic signaling.</param>
  54       <returns>true if the timer was successfully updated; otherwise, false.</returns>
  55       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.Timer"></see> has already been disposed.</exception>
  56       <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime">dueTime</paramref> or <paramref name="period">period</paramref> parameter is negative and is not equal to <see cref="F:System.Threading.Timeout.Infinite"></see>.</exception>
  57     </member>
  58     <member name="M:System.Threading.Timer.Change(System.Int64,System.Int64)">
  59       <summary>Changes the start time and the interval between method invocations for a timer, using 64-bit signed integers to measure time intervals.</summary>
  60       <param name="dueTime">The amount of time to delay before the invoking the callback method specified when the <see cref="T:System.Threading.Timer"></see> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to prevent the timer from restarting. Specify zero (0) to restart the timer immediately.</param>
  61       <param name="period">The time interval between invocations of the callback method specified when the <see cref="T:System.Threading.Timer"></see> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to disable periodic signaling.</param>
  62       <returns>true if the timer was successfully updated; otherwise, false.</returns>
  63       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.Timer"></see> has already been disposed.</exception>
  64       <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime">dueTime</paramref> or <paramref name="period">period</paramref> parameter is less than -1.</exception>
  65       <exception cref="T:System.NotSupportedException">The <paramref name="dueTime">dueTime</paramref> or <paramref name="period">period</paramref> parameter is greater than 4294967294.</exception>
  66     </member>
  67     <member name="M:System.Threading.Timer.Change(System.TimeSpan,System.TimeSpan)">
  68       <summary>Changes the start time and the interval between method invocations for a timer, using <see cref="T:System.TimeSpan"></see> values to measure time intervals.</summary>
  69       <param name="dueTime">A <see cref="T:System.TimeSpan"></see> representing the amount of time to delay before invoking the callback method specified when the <see cref="T:System.Threading.Timer"></see> was constructed. Specify negative one (-1) milliseconds to prevent the timer from restarting. Specify zero (0) to restart the timer immediately.</param>
  70       <param name="period">The time interval between invocations of the callback method specified when the <see cref="T:System.Threading.Timer"></see> was constructed. Specify negative one (-1) milliseconds to disable periodic signaling.</param>
  71       <returns>true if the timer was successfully updated; otherwise, false.</returns>
  72       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.Timer"></see> has already been disposed.</exception>
  73       <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="dueTime">dueTime</paramref> or <paramref name="period">period</paramref> parameter, in milliseconds, is less than -1.</exception>
  74       <exception cref="T:System.NotSupportedException">The <paramref name="dueTime">dueTime</paramref> or <paramref name="period">period</paramref> parameter, in milliseconds, is greater than 4294967294.</exception>
  75     </member>
  76     <member name="M:System.Threading.Timer.Change(System.UInt32,System.UInt32)">
  77       <summary>Changes the start time and the interval between method invocations for a timer, using 32-bit unsigned integers to measure time intervals.</summary>
  78       <param name="dueTime">The amount of time to delay before the invoking the callback method specified when the <see cref="T:System.Threading.Timer"></see> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to prevent the timer from restarting. Specify zero (0) to restart the timer immediately.</param>
  79       <param name="period">The time interval between invocations of the callback method specified when the <see cref="T:System.Threading.Timer"></see> was constructed, in milliseconds. Specify <see cref="F:System.Threading.Timeout.Infinite"></see> to disable periodic signaling.</param>
  80       <returns>true if the timer was successfully updated; otherwise, false.</returns>
  81       <exception cref="T:System.ObjectDisposedException">The <see cref="T:System.Threading.Timer"></see> has already been disposed.</exception>
  82     </member>
  83     <member name="M:System.Threading.Timer.Dispose">
  84       <summary>Releases all resources used by the current instance of <see cref="T:System.Threading.Timer"></see>.</summary>
  85     </member>
  86     <member name="M:System.Threading.Timer.Dispose(System.Threading.WaitHandle)">
  87       <summary>Releases all resources used by the current instance of <see cref="T:System.Threading.Timer"></see> and signals when the timer has been disposed of.</summary>
  88       <param name="notifyObject">The <see cref="T:System.Threading.WaitHandle"></see> to be signaled when the Timer has been disposed of.</param>
  89       <returns>true if the function succeeds; otherwise, false.</returns>
  90       <exception cref="T:System.ArgumentNullException">The <paramref name="notifyObject">notifyObject</paramref> parameter is null.</exception>
  91     </member>
  92     <member name="T:System.Threading.TimerCallback">
  93       <summary>Represents the method that handles calls from a <see cref="T:System.Threading.Timer"></see>.</summary>
  94       <param name="state">An object containing application-specific information relevant to the method invoked by this delegate, or null.</param>
  95     </member>
  96   </members>
  97 </doc></span>