class/corlib/System.Threading/ThreadPool.cs

   1 //
   2 // System.Threading.ThreadPool.cs
   3 //
   4 // Author:
   5 //   Patrik Torstensson
   6 //   Dick Porter (dick@ximian.com)
   7 //   Maurer Dietmar (dietmar@ximian.com)
   8 //
   9 // (C) Ximian, Inc.  http://www.ximian.com
  10 // Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
  11 //
  12 // Permission is hereby granted, free of charge, to any person obtaining
  13 // a copy of this software and associated documentation files (the
  14 // "Software"), to deal in the Software without restriction, including
  15 // without limitation the rights to use, copy, modify, merge, publish,
  16 // distribute, sublicense, and/or sell copies of the Software, and to
  17 // permit persons to whom the Software is furnished to do so, subject to
  18 // the following conditions:
  19 //
  20 // The above copyright notice and this permission notice shall be
  21 // included in all copies or substantial portions of the Software.
  22 //
  23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  30 //
  31
  32 using System.Collections;
  33 using System.Globalization;
  34 using System.Runtime.CompilerServices;
  35 using System.Runtime.Remoting.Messaging;
  36 using System.Runtime.InteropServices;
  37 using System.Security.Permissions;
  38
  39 namespace System.Threading {
  40
  41         public static class ThreadPool {
  42                 [Obsolete("This method is obsolete, use BindHandle(SafeHandle) instead")]
  43                 public static bool BindHandle (IntPtr osHandle)
  44                 {
  45                         return true;
  46                 }
  47
  48                 public static bool BindHandle (SafeHandle osHandle)
  49                 {
  50                         if (osHandle == null)
  51                                 throw new ArgumentNullException ("osHandle");
  52
  53                         return true;
  54                 }
  55
  56 #if !NET_2_1
  57                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
  58                 public static extern void GetAvailableThreads (out int workerThreads, out int completionPortThreads);
  59 #endif
  60                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
  61                 public static extern void GetMaxThreads (out int workerThreads, out int completionPortThreads);
  62
  63                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
  64                 public static extern void GetMinThreads (out int workerThreads, out int completionPortThreads);
  65
  66                 [MonoTODO("The min number of completion port threads is not evaluated.")]
  67                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
  68                 [SecurityPermission (SecurityAction.Demand, ControlThread=true)]
  69                 public static extern bool SetMinThreads (int workerThreads, int completionPortThreads);
  70
  71                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
  72                 [SecurityPermission (SecurityAction.Demand, ControlThread=true)]
  73                 public static extern bool SetMaxThreads (int workerThreads, int completionPortThreads);
  74
  75                 public static bool QueueUserWorkItem (WaitCallback callBack)
  76                 {
  77                         return QueueUserWorkItem (callBack, null);
  78                 }
  79
  80                 public static bool QueueUserWorkItem (WaitCallback callBack, object state)
  81                 {
  82                         if (callBack == null)
  83                                 throw new ArgumentNullException ("callBack");
  84
  85 #if MOONLIGHT
  86                         callBack = MoonlightHandler (callBack);
  87 #endif
  88                         IAsyncResult ar = callBack.BeginInvoke (state, null, null);
  89                         if (ar == null)
  90                                 return false;
  91                         return true;
  92                 }
  93
  94                 public static RegisteredWaitHandle RegisterWaitForSingleObject (WaitHandle waitObject,
  95                                                                                 WaitOrTimerCallback callBack,
  96                                                                                 object state,
  97                                                                                 int millisecondsTimeOutInterval,
  98                                                                                 bool executeOnlyOnce)
  99                 {
 100                         return RegisterWaitForSingleObject (waitObject, callBack, state,
 101                                                             (long) millisecondsTimeOutInterval, executeOnlyOnce);
 102                 }
 103
 104                 public static RegisteredWaitHandle RegisterWaitForSingleObject (WaitHandle waitObject,
 105                                                                                 WaitOrTimerCallback callBack,
 106                                                                                 object state,
 107                                                                                 long millisecondsTimeOutInterval,
 108                                                                                 bool executeOnlyOnce)
 109                 {
 110                         if (millisecondsTimeOutInterval < -1)
 111                                 throw new ArgumentOutOfRangeException ("timeout", "timeout < -1");
 112
 113                         if (millisecondsTimeOutInterval > Int32.MaxValue)
 114                                 throw new NotSupportedException ("Timeout is too big. Maximum is Int32.MaxValue");
 115
 116                         TimeSpan timeout = new TimeSpan (0, 0, 0, 0, (int) millisecondsTimeOutInterval);
 117
 118                         RegisteredWaitHandle waiter = new RegisteredWaitHandle (waitObject, callBack, state,
 119                                                                                 timeout, executeOnlyOnce);
 120                         QueueUserWorkItem (new WaitCallback (waiter.Wait), null);
 121                         return waiter;
 122                 }
 123
 124                 public static RegisteredWaitHandle RegisterWaitForSingleObject (WaitHandle waitObject,
 125                                                                                 WaitOrTimerCallback callBack,
 126                                                                                 object state,
 127                                                                                 TimeSpan timeout,
 128                                                                                 bool executeOnlyOnce)
 129                 {
 130                         return RegisterWaitForSingleObject (waitObject, callBack, state,
 131                                                             (long) timeout.TotalMilliseconds, executeOnlyOnce);
 132
 133                 }
 134
 135                 [CLSCompliant(false)]
 136                 public static RegisteredWaitHandle RegisterWaitForSingleObject (WaitHandle waitObject,
 137                                                                                 WaitOrTimerCallback callBack,
 138                                                                                 object state,
 139                                                                                 uint millisecondsTimeOutInterval,
 140                                                                                 bool executeOnlyOnce)
 141                 {
 142                         return RegisterWaitForSingleObject (waitObject, callBack, state,
 143                                                             (long) millisecondsTimeOutInterval, executeOnlyOnce);
 144                 }
 145
 146 #if !NET_2_1
 147
 148                 [CLSCompliant (false)]
 149                 unsafe public static bool UnsafeQueueNativeOverlapped (NativeOverlapped *overlapped)
 150                 {
 151                         throw new NotImplementedException ();
 152                 }
 153
 154                 [SecurityPermission (SecurityAction.Demand, ControlEvidence=true, ControlPolicy=true)]
 155                 public static bool UnsafeQueueUserWorkItem (WaitCallback callBack, object state)
 156                 {
 157                         // no stack propagation here (that's why it's unsafe and requires extra security permissions)
 158                         IAsyncResult ar = null;
 159                         try {
 160                                 if (!ExecutionContext.IsFlowSuppressed ())
 161                                         ExecutionContext.SuppressFlow (); // on current thread only
 162
 163                                 ar = callBack.BeginInvoke (state, null, null);
 164                         }
 165                         finally {
 166                                 if (ExecutionContext.IsFlowSuppressed ())
 167                                         ExecutionContext.RestoreFlow ();
 168                         }
 169                         return (ar != null);
 170                 }
 171
 172                 [MonoTODO("Not implemented")]
 173                 [SecurityPermission (SecurityAction.Demand, ControlEvidence=true, ControlPolicy=true)]
 174                 public static RegisteredWaitHandle UnsafeRegisterWaitForSingleObject (WaitHandle waitObject,
 175                         WaitOrTimerCallback callBack, object state, int millisecondsTimeOutInterval,
 176                         bool executeOnlyOnce)
 177                 {
 178                         throw new NotImplementedException ();
 179                 }
 180
 181                 [MonoTODO("Not implemented")]
 182                 [SecurityPermission (SecurityAction.Demand, ControlEvidence=true, ControlPolicy=true)]
 183                 public static RegisteredWaitHandle UnsafeRegisterWaitForSingleObject (WaitHandle waitObject,
 184                         WaitOrTimerCallback callBack, object state, long millisecondsTimeOutInterval,
 185                         bool executeOnlyOnce)
 186                 {
 187                         throw new NotImplementedException ();
 188                 }
 189
 190                 [MonoTODO("Not implemented")]
 191                 [SecurityPermission (SecurityAction.Demand, ControlEvidence=true, ControlPolicy=true)]
 192                 public static RegisteredWaitHandle UnsafeRegisterWaitForSingleObject (WaitHandle waitObject,
 193                         WaitOrTimerCallback callBack, object state, TimeSpan timeout,
 194                         bool executeOnlyOnce)
 195                 {
 196                         throw new NotImplementedException ();
 197                 }
 198
 199                 [MonoTODO("Not implemented")]
 200                 [CLSCompliant (false)]
 201                 [SecurityPermission (SecurityAction.Demand, ControlEvidence=true, ControlPolicy=true)]
 202                 public static RegisteredWaitHandle UnsafeRegisterWaitForSingleObject (WaitHandle waitObject,
 203                         WaitOrTimerCallback callBack, object state, uint millisecondsTimeOutInterval,
 204                         bool executeOnlyOnce)
 205                 {
 206                         throw new NotImplementedException ();
 207                 }
 208
 209 #endif
 210
 211 #if MOONLIGHT
 212                 static WaitCallback MoonlightHandler (WaitCallback callback)
 213                 {
 214                         return delegate (object o) {
 215                                 try {
 216                                         callback (o);
 217                                 }
 218                                 catch (Exception ex) {
 219                                         Thread.MoonlightUnhandledException (ex);
 220                                 }
 221                         };
 222                 }
 223 #endif
 224         }
 225 }