mcs/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 (callBack.IsTransparentProxy ()) {
  86                                 IAsyncResult ar = callBack.BeginInvoke (state, null, null);
  87                                 if (ar == null)
  88                                         return false;
  89                         } else {
  90                                 AsyncResult ares = new AsyncResult (callBack, state, true);
  91                                 pool_queue (ares);
  92                         }
  93                         return true;
  94                 }
  95
  96                 [MethodImplAttribute(MethodImplOptions.InternalCall)]
  97                 static extern void pool_queue (AsyncResult ares);
  98
  99                 // TODO: It should be interface interface only to avoid extra allocation
 100                 internal static void QueueWorkItem (WaitCallback callBack, object state)
 101                 {
 102                         pool_queue (new AsyncResult (callBack, state, false));
 103                 }
 104
 105                 public static RegisteredWaitHandle RegisterWaitForSingleObject (WaitHandle waitObject,
 106                                                                                 WaitOrTimerCallback callBack,
 107                                                                                 object state,
 108                                                                                 int millisecondsTimeOutInterval,
 109                                                                                 bool executeOnlyOnce)
 110                 {
 111                         return RegisterWaitForSingleObject (waitObject, callBack, state,
 112                                                             (long) millisecondsTimeOutInterval, executeOnlyOnce);
 113                 }
 114
 115                 public static RegisteredWaitHandle RegisterWaitForSingleObject (WaitHandle waitObject,
 116                                                                                 WaitOrTimerCallback callBack,
 117                                                                                 object state,
 118                                                                                 long millisecondsTimeOutInterval,
 119                                                                                 bool executeOnlyOnce)
 120                 {
 121                         if (waitObject == null)
 122                                 throw new ArgumentNullException ("waitObject");
 123
 124                         if (callBack == null)
 125                                 throw new ArgumentNullException ("callBack");
 126
 127                         if (millisecondsTimeOutInterval < -1)
 128                                 throw new ArgumentOutOfRangeException ("timeout", "timeout < -1");
 129
 130                         if (millisecondsTimeOutInterval > Int32.MaxValue)
 131                                 throw new NotSupportedException ("Timeout is too big. Maximum is Int32.MaxValue");
 132
 133                         TimeSpan timeout = new TimeSpan (0, 0, 0, 0, (int) millisecondsTimeOutInterval);
 134
 135                         RegisteredWaitHandle waiter = new RegisteredWaitHandle (waitObject, callBack, state,
 136                                                                                 timeout, executeOnlyOnce);
 137                         QueueUserWorkItem (new WaitCallback (waiter.Wait), null);
 138                         return waiter;
 139                 }
 140
 141                 public static RegisteredWaitHandle RegisterWaitForSingleObject (WaitHandle waitObject,
 142                                                                                 WaitOrTimerCallback callBack,
 143                                                                                 object state,
 144                                                                                 TimeSpan timeout,
 145                                                                                 bool executeOnlyOnce)
 146                 {
 147                         return RegisterWaitForSingleObject (waitObject, callBack, state,
 148                                                             (long) timeout.TotalMilliseconds, executeOnlyOnce);
 149
 150                 }
 151
 152                 [CLSCompliant(false)]
 153                 public static RegisteredWaitHandle RegisterWaitForSingleObject (WaitHandle waitObject,
 154                                                                                 WaitOrTimerCallback callBack,
 155                                                                                 object state,
 156                                                                                 uint millisecondsTimeOutInterval,
 157                                                                                 bool executeOnlyOnce)
 158                 {
 159                         return RegisterWaitForSingleObject (waitObject, callBack, state,
 160                                                             (long) millisecondsTimeOutInterval, executeOnlyOnce);
 161                 }
 162
 163                 [CLSCompliant (false)]
 164                 unsafe public static bool UnsafeQueueNativeOverlapped (NativeOverlapped *overlapped)
 165                 {
 166                         throw new NotImplementedException ();
 167                 }
 168
 169 #if !NET_2_1 || MOBILE
 170
 171                 [SecurityPermission (SecurityAction.Demand, ControlEvidence=true, ControlPolicy=true)]
 172                 public static bool UnsafeQueueUserWorkItem (WaitCallback callBack, object state)
 173                 {
 174                         if (callBack == null)
 175                                 throw new ArgumentNullException ("callBack");
 176
 177                         // no stack propagation here (that's why it's unsafe and requires extra security permissions)
 178                         if (!callBack.IsTransparentProxy ()) {
 179                                 AsyncResult ares = new AsyncResult (callBack, state, false);
 180                                 pool_queue (ares);
 181                                 return true;
 182                         }
 183                         try {
 184                                 if (!ExecutionContext.IsFlowSuppressed ())
 185                                         ExecutionContext.SuppressFlow (); // on current thread only
 186                                 IAsyncResult ar = callBack.BeginInvoke (state, null, null);
 187                                 if (ar == null)
 188                                         return false;
 189                         } finally {
 190                                 if (ExecutionContext.IsFlowSuppressed ())
 191                                         ExecutionContext.RestoreFlow ();
 192                         }
 193                         return true;
 194                 }
 195
 196                 [MonoTODO("Not implemented")]
 197                 [SecurityPermission (SecurityAction.Demand, ControlEvidence=true, ControlPolicy=true)]
 198                 public static RegisteredWaitHandle UnsafeRegisterWaitForSingleObject (WaitHandle waitObject,
 199                         WaitOrTimerCallback callBack, object state, int millisecondsTimeOutInterval,
 200                         bool executeOnlyOnce)
 201                 {
 202                         throw new NotImplementedException ();
 203                 }
 204
 205                 [MonoTODO("Not implemented")]
 206                 [SecurityPermission (SecurityAction.Demand, ControlEvidence=true, ControlPolicy=true)]
 207                 public static RegisteredWaitHandle UnsafeRegisterWaitForSingleObject (WaitHandle waitObject,
 208                         WaitOrTimerCallback callBack, object state, long millisecondsTimeOutInterval,
 209                         bool executeOnlyOnce)
 210                 {
 211                         throw new NotImplementedException ();
 212                 }
 213
 214                 [MonoTODO("Not implemented")]
 215                 [SecurityPermission (SecurityAction.Demand, ControlEvidence=true, ControlPolicy=true)]
 216                 public static RegisteredWaitHandle UnsafeRegisterWaitForSingleObject (WaitHandle waitObject,
 217                         WaitOrTimerCallback callBack, object state, TimeSpan timeout,
 218                         bool executeOnlyOnce)
 219                 {
 220                         throw new NotImplementedException ();
 221                 }
 222
 223                 [MonoTODO("Not implemented")]
 224                 [CLSCompliant (false)]
 225                 [SecurityPermission (SecurityAction.Demand, ControlEvidence=true, ControlPolicy=true)]
 226                 public static RegisteredWaitHandle UnsafeRegisterWaitForSingleObject (WaitHandle waitObject,
 227                         WaitOrTimerCallback callBack, object state, uint millisecondsTimeOutInterval,
 228                         bool executeOnlyOnce)
 229                 {
 230                         throw new NotImplementedException ();
 231                 }
 232
 233 #endif
 234         }
 235 }