File: TimerCallback.xml

package info (click to toggle)
mono 6.14.1%2Bds2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,282,732 kB
  • sloc: cs: 11,182,461; xml: 2,850,281; ansic: 699,123; cpp: 122,919; perl: 58,604; javascript: 30,841; asm: 21,845; makefile: 19,602; sh: 10,973; python: 4,772; pascal: 925; sql: 859; sed: 16; php: 1
file content (45 lines) | stat: -rw-r--r-- 3,326 bytes parent folder | download | duplicates (8)
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
<?xml version="1.0" encoding="utf-8"?>
<Type Name="TimerCallback" FullName="System.Threading.TimerCallback" FullNameSP="System_Threading_TimerCallback" Maintainer="ecma">
  <TypeSignature Language="ILASM" Value=".class public sealed serializable TimerCallback extends System.Delegate" />
  <TypeSignature Language="C#" Value="public delegate void TimerCallback(object state);" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed TimerCallback extends System.MulticastDelegate" />
  <MemberOfLibrary>BCL</MemberOfLibrary>
  <AssemblyInfo>
    <AssemblyName>mscorlib</AssemblyName>
    <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Delegate</BaseTypeName>
  </Base>
  <Attributes>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
    </Attribute>
  </Attributes>
  <Parameters>
    <Parameter Name="state" Type="System.Object" />
  </Parameters>
  <ReturnValue>
    <ReturnType>System.Void</ReturnType>
  </ReturnValue>
  <Docs>
    <param name="state">A <see cref="T:System.Object" /> containing application-specific information relevant to the methods invoked by instances of this delegate, or <see langword="null" /> . </param>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Use a TimerCallback delegate to specify the method that is called by a <see cref="T:System.Threading.Timer" />. This method does not execute in the thread that created the timer; it executes in a separate thread pool thread that is provided by the system. The TimerCallback delegate invokes the method once after the start time elapses, and continues to invoke it once per timer interval until the <see cref="M:System.Threading.Timer.Dispose(System.Threading.WaitHandle)" /> method is called, or until the <see cref="M:System.Threading.Timer.Change(System.Int32,System.Int32)" /> method is called with the interval value <see cref="F:System.Threading.Timeout.Infinite" />.</para>
      <block subset="none" type="note">
        <para>Callbacks can occur after the <see cref="M:System.Threading.Timer.Dispose" /> method overload has been called, because the timer queues callbacks for execution by thread pool threads. You can use the <see cref="M:System.Threading.Timer.Dispose(System.Threading.WaitHandle)" /> method overload to wait until all callbacks have completed.</para>
      </block>
      <para>The timer delegate is specified when the timer is constructed, and cannot be changed. The start time for a Timer is passed in the <paramref name="dueTime" /> parameter of the Timer constructors, and the period is passed in the <paramref name="period" /> parameter. For an example that demonstrates creating and using a TimerCallback delegate, see <see cref="T:System.Threading.Timer" />.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Represents the method that handles calls from a <see cref="T:System.Threading.Timer" />.</para>
    </summary>
  </Docs>
  <Members />
  <TypeExcluded>0</TypeExcluded>
</Type>