File: ThreadState.xml

package info (click to toggle)
monodoc 1.1.18-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 58,432 kB
  • ctags: 4,991
  • sloc: xml: 718,392; cs: 38,337; sh: 3,172; perl: 554; makefile: 303
file content (255 lines) | stat: -rwxr-xr-x 11,027 bytes parent folder | download
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<Type Name="ThreadState" FullName="System.Threading.ThreadState" FullNameSP="System_Threading_ThreadState" Maintainer="ecma">
  <TypeSignature Language="ILASM" Value=".class public sealed serializable ThreadState extends System.Enum" />
  <TypeSignature Language="C#" Value="public enum ThreadState" />
  <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>
  </AssemblyInfo>
  <Docs>
    <summary>
      <para> Specifies the execution states of a <see cref="T:System.Threading.Thread" />.</para>
    </summary>
    <remarks>
      <para>
        <see cref="T:System.Threading.ThreadState" />
defines the set of possible execution states for threads. Once a thread is
created, it is in one or more of these states until it terminates. Not all
combinations of <see langword="ThreadState" /> values are valid; for example,
a thread cannot be in both the <see cref="F:System.Threading.ThreadState.Stopped" /> and <see cref="F:System.Threading.ThreadState.Unstarted" />
states.</para>
      <para>The following table shows the actions that cause a thread to
   change state.</para>
      <list type="table">
        <listheader>
          <term>Action</term>
          <description>ThreadState after Action</description>
        </listheader>
        <item>
          <term> The
      thread is created</term>
          <description>Unstarted</description>
        </item>
        <item>
          <term>
            <see cref="M:System.Threading.Thread.Start" /> is invoked on the thread</term>
          <description>Running</description>
        </item>
        <item>
          <term> The thread calls <see cref="M:System.Threading.Thread.Sleep(System.Int32)" /></term>
          <description>WaitSleepJoin</description>
        </item>
        <item>
          <term> The thread calls <see cref="M:System.Threading.Monitor.Wait(System.Object,System.Int32,System.Boolean)" /> to wait
   on an object</term>
          <description>WaitSleepJoin</description>
        </item>
        <item>
          <term> The thread calls <see cref="M:System.Threading.Thread.Join" /> to wait for
   another thread to terminate</term>
          <description>WaitSleepJoin</description>
        </item>
        <item>
          <term> The
      <see cref="T:System.Threading.ThreadStart" />
   delegate methods finish executing</term>
          <description>Stopped</description>
        </item>
        <item>
          <term> Another thread requests
      the thread to <see cref="M:System.Threading.Thread.Abort(System.Object)" /></term>
          <description>AbortRequested</description>
        </item>
        <item>
          <term> The thread accepts a <see cref="M:System.Threading.Thread.Abort(System.Object)" /> request</term>
          <description>Aborted</description>
        </item>
      </list>
      <para>In addition to the states noted above, there is also the <see cref="F:System.Threading.ThreadState.Background" /> state, which indicates whether the thread is
running in the background or foreground.</para>
      <para>The current state of a thread can be retrieved from the <see cref="P:System.Threading.Thread.ThreadState" /> property,
whose value is a combination of the <see cref="T:System.Threading.ThreadState" />
values. Once a thread has reached the <see cref="F:System.Threading.ThreadState.Stopped" /> state, it cannot change to any other state. </para>
    </remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Attributes>
    <Attribute>
      <AttributeName>System.Flags</AttributeName>
    </Attribute>
  </Attributes>
  <Members>
    
    <Member MemberName="Running">
      <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Threading.ThreadState Running = 0x0" />
      <MemberSignature Language="C#" Value="Running" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Threading.ThreadState</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>Running</MemberValue>
      <Docs>
        <summary>
          <para>The thread represented by an instance of <see cref="T:System.Threading.Thread" /> has been started and has not terminated.</para>
          <para>To determine if a thread 
   is running, check that its state does not include <see cref="F:System.Threading.ThreadState.Unstarted" /> and does not include <see cref="F:System.Threading.ThreadState.Stopped" />.</para>
        </summary>
        <remarks>To be added.</remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="Background">
      <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Threading.ThreadState Background = 0x4" />
      <MemberSignature Language="C#" Value="Background" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Threading.ThreadState</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>Background</MemberValue>
      <Docs>
        <summary>
          <para>The thread represented by an instance of <see cref="T:System.Threading.Thread" /> is being
 executed as a background thread, as opposed to a foreground thread. <block subset="none" type="note">This state is controlled by setting the <see cref="P:System.Threading.Thread.IsBackground" />
 
 property.</block></para>
        </summary>
        <remarks>To be added.</remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="Unstarted">
      <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Threading.ThreadState Unstarted = 0x8" />
      <MemberSignature Language="C#" Value="Unstarted" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Threading.ThreadState</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>Unstarted</MemberValue>
      <Docs>
        <summary>
          <para>The <see cref="M:System.Threading.Thread.Start" qualify="true" /> method 
has not been invoked on the thread.</para>
        </summary>
        <remarks>To be added.</remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="Stopped">
      <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Threading.ThreadState Stopped = 0x10" />
      <MemberSignature Language="C#" Value="Stopped" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Threading.ThreadState</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>Stopped</MemberValue>
      <Docs>
        <summary>
          <para>The thread represented by an instance of <see cref="T:System.Threading.Thread" />
has terminated.</para>
        </summary>
        <remarks>To be added.</remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="WaitSleepJoin">
      <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Threading.ThreadState WaitSleepJoin = 0x20" />
      <MemberSignature Language="C#" Value="WaitSleepJoin" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Threading.ThreadState</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>WaitSleepJoin</MemberValue>
      <Docs>
        <summary>
          <para>The thread represented by an instance of <see cref="T:System.Threading.Thread" /> is
 blocked as
 a result of
 a call to <see cref="M:System.Threading.Monitor.Wait(System.Object,System.Int32,System.Boolean)" />, <see cref="M:System.Threading.Thread.Sleep(System.Int32)" />, or <see cref="M:System.Threading.Thread.Join" />.</para>
        </summary>
        <remarks>To be added.</remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="AbortRequested">
      <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Threading.ThreadState AbortRequested = 0x80" />
      <MemberSignature Language="C#" Value="AbortRequested" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Threading.ThreadState</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>AbortRequested</MemberValue>
      <Docs>
        <summary>
          <para>The <see cref="M:System.Threading.Thread.Abort(System.Object)" /> method has been invoked on the thread, but the thread
 has not yet received the pending <see cref="T:System.Threading.ThreadAbortException" /> that will attempt to terminate it.</para>
        </summary>
        <remarks>To be added.</remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="Aborted">
      <MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Threading.ThreadState Aborted = 0x100" />
      <MemberSignature Language="C#" Value="Aborted" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Threading.ThreadState</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>Aborted</MemberValue>
      <Docs>
        <summary>
          <para>The thread represented by an instance of <see cref="T:System.Threading.Thread" /> has terminated as a result of a call to <see cref="M:System.Threading.Thread.Abort(System.Object)" />. A thread in this
   state is also in the <see cref="F:System.Threading.ThreadState.Stopped" /> state.</para>
        </summary>
        <remarks>To be added.</remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
  <Member MemberName="StopRequested">
      <MemberSignature Language="C#" Value="StopRequested" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Threading.ThreadState</ReturnType>
      </ReturnValue>
      <MemberValue>StopRequested</MemberValue>
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  <Member MemberName="SuspendRequested">
      <MemberSignature Language="C#" Value="SuspendRequested" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Threading.ThreadState</ReturnType>
      </ReturnValue>
      <MemberValue>SuspendRequested</MemberValue>
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  <Member MemberName="Suspended">
      <MemberSignature Language="C#" Value="Suspended" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Threading.ThreadState</ReturnType>
      </ReturnValue>
      <MemberValue>Suspended</MemberValue>
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
  <TypeExcluded>0</TypeExcluded>
</Type>