2005-01-31 Zoltan Varga <vargaz@freemail.hu>
[mono.git] / mcs / class / corlib / System.Threading / ThreadState.cs
index 448bd2031a669b17b155a93f246b484d725ddcbf..f17a9854c960ed47968a99bf01dbd99dd709e1d0 100644 (file)
-// ThreadState.cs\r
-//\r
-// This code was automatically generated from\r
-// ECMA CLI XML Library Specification.\r
-// Generator: libgen.xsl\r
-// Source file: AllTypes.xml\r
-// URL: http://msdn.microsoft.com/net/ecma/AllTypes.xml\r
-//\r
-// (C) 2001 Ximian, Inc.  http://www.ximian.com\r
-\r
-\r
-namespace System.Threading {\r
-\r
-\r
-       /// <summary>\r
-       /// <para> Specifies the execution states of a <see cref="T:System.Threading.Thread" />.</para>\r
-       /// </summary>\r
-       /// <remarks>\r
-       /// <para>\r
-       /// <see cref="T:System.Threading.ThreadState" />\r
-       /// defines the set of possible execution states for threads. Once a thread is\r
-       /// created, it is in one or more of these states until it terminates. Not all\r
-       /// combinations of <see langword="ThreadState" /> values are valid; for example,\r
-       /// a thread cannot be in both the <see cref="F:System.Threading.ThreadState.Stopped" /> and <see cref="F:System.Threading.ThreadState.Unstarted" />\r
-       /// states.</para>\r
-       /// <para>The following table shows the actions that cause a thread to\r
-       ///    change state.</para>\r
-       /// <list type="table">\r
-       /// <listheader>\r
-       /// <term>Action</term>\r
-       /// <description>ThreadState after Action</description>\r
-       /// </listheader>\r
-       /// <item>\r
-       /// <term> The\r
-       ///       thread is created</term>\r
-       /// <description>Unstarted</description>\r
-       /// </item>\r
-       /// <item>\r
-       /// <term>\r
-       /// <see cref="M:System.Threading.Thread.Start" /> is invoked on the thread</term>\r
-       /// <description>Running</description>\r
-       /// </item>\r
-       /// <item>\r
-       /// <term> The thread calls <see cref="M:System.Threading.Thread.Sleep(System.Int32)" /></term>\r
-       /// <description>WaitSleepJoin</description>\r
-       /// </item>\r
-       /// <item>\r
-       /// <term> The thread calls <see cref="M:System.Threading.Monitor.Wait(System.Object,System.Int32,System.Boolean)" /> to wait\r
-       ///    on an object</term>\r
-       /// <description>WaitSleepJoin</description>\r
-       /// </item>\r
-       /// <item>\r
-       /// <term> The thread calls <see cref="M:System.Threading.Thread.Join" /> to wait for\r
-       ///    another thread to terminate</term>\r
-       /// <description>WaitSleepJoin</description>\r
-       /// </item>\r
-       /// <item>\r
-       /// <term> The \r
-       ///    <see cref="T:System.Threading.ThreadStart" />\r
-       ///    delegate methods finish executing</term>\r
-       /// <description>Stopped</description>\r
-       /// </item>\r
-       /// <item>\r
-       /// <term> Another thread requests\r
-       ///       the thread to <see cref="M:System.Threading.Thread.Abort(System.Object)" /></term>\r
-       /// <description>AbortRequested</description>\r
-       /// </item>\r
-       /// <item>\r
-       /// <term> The thread accepts a <see cref="M:System.Threading.Thread.Abort(System.Object)" /> request</term>\r
-       /// <description>Aborted</description>\r
-       /// </item>\r
-       /// </list>\r
-       /// <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\r
-       /// running in the background or foreground.</para>\r
-       /// The current state of a thread can be retrieved from the <see cref="P:System.Threading.Thread.ThreadState" /> property,\r
-       /// whose value is a combination of the <see cref="T:System.Threading.ThreadState" /> values. Once a\r
-       /// thread has reached a final state, (<see cref="F:System.Threading.ThreadState.Stopped" />\r
-       /// or <see cref="F:System.Threading.ThreadState.Aborted" />), it cannot change to any other state.\r
-       /// </remarks>\r
-       [Flags]\r
-       public enum ThreadState {\r
-\r
-               /// <summary><para>The thread represented by an instance of <see cref="T:System.Threading.Thread" /> has been started, is not blocked or stopped, and has no pending <see cref="T:System.Threading.ThreadAbortException" />.</para></summary>\r
-               Running = 0x00000000,\r
-\r
-               /// <summary><para>The thread represented by an instance of <see cref="T:System.Threading.Thread" /> is being\r
-               ///  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" />\r
-               ///  \r
-               ///  property.</block></para></summary>\r
-               Background = 0x00000004,\r
-\r
-               /// <summary><para>The <see cref="M:System.Threading.Thread.Start" qualify="true" /> method \r
-               /// has not been invoked on the thread.</para></summary>\r
-               Unstarted = 0x00000008,\r
-\r
-               /// <summary><para>The thread represented by an instance of <see cref="T:System.Threading.Thread" />\r
-               /// has terminated normally.</para></summary>\r
-               Stopped = 0x00000010,\r
-\r
-               /// <summary><para>The thread represented by an instance of <see cref="T:System.Threading.Thread" /> is\r
-               ///  blocked as\r
-               ///  a result of\r
-               ///  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>\r
-               WaitSleepJoin = 0x00000020,\r
-\r
-               /// <summary><para>The <see cref="M:System.Threading.Thread.Abort(System.Object)" /> method has been invoked on the thread, but the thread\r
-               ///  has not yet received the pending <see cref="T:System.Threading.ThreadAbortException" /> that will attempt to terminate it.</para></summary>\r
-               AbortRequested = 0x00000080,\r
-\r
-               /// <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="!:System.Threading.Abort" />.</para></summary>\r
-               Aborted = 0x00000100,\r
-       } // ThreadState\r
-\r
-} // System.Threading\r
+// ThreadState.cs
+//
+// This code was automatically generated from
+// ECMA CLI XML Library Specification.
+// Generator: libgen.xsl [1.0; (C) Sergey Chaban (serge@wildwestsoftware.com)]
+// Created: Wed, 5 Sep 2001 06:30:30 UTC
+// Source file: AllTypes.xml
+// URL: http://msdn.microsoft.com/net/ecma/AllTypes.xml
+//
+// (C) 2001 Ximian, Inc.  http://www.ximian.com
+
+//
+// Copyright (C) 2004 Novell, Inc (http://www.novell.com)
+//
+// Permission is hereby granted, free of charge, to any person obtaining
+// a copy of this software and associated documentation files (the
+// "Software"), to deal in the Software without restriction, including
+// without limitation the rights to use, copy, modify, merge, publish,
+// distribute, sublicense, and/or sell copies of the Software, and to
+// permit persons to whom the Software is furnished to do so, subject to
+// the following conditions:
+// 
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+// 
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//
+
+
+namespace System.Threading {
+
+
+       /// <summary>
+       /// </summary>
+       [Flags]
+       public enum ThreadState {
+
+               /// <summary>
+               /// </summary>
+               Running = 0x00000000,
+
+               StopRequested = 0x00000001,
+               SuspendRequested = 0x00000002,
+               
+               /// <summary>
+               /// </summary>
+               Background = 0x00000004,
+
+               /// <summary>
+               /// </summary>
+               Unstarted = 0x00000008,
+
+               /// <summary>
+               /// </summary>
+               Stopped = 0x00000010,
+
+               /// <summary>
+               /// </summary>
+               WaitSleepJoin = 0x00000020,
+
+               Suspended = 0x00000040,
+
+               /// <summary>
+               /// </summary>
+               AbortRequested = 0x00000080,
+
+               /// <summary>
+               /// </summary>
+               Aborted = 0x00000100,
+   } // ThreadState
+
+} // System.Threading