mcs/class/corlib/System.Threading.Tasks/ParallelLoopState.cs

   1 // ParallelState.cs
   2 //
   3 // Copyright (c) 2008 Jérémie "Garuma" Laval
   4 //
   5 // Permission is hereby granted, free of charge, to any person obtaining a copy
   6 // of this software and associated documentation files (the "Software"), to deal
   7 // in the Software without restriction, including without limitation the rights
   8 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 // copies of the Software, and to permit persons to whom the Software is
  10 // furnished to do so, subject to the following conditions:
  11 //
  12 // The above copyright notice and this permission notice shall be included in
  13 // all copies or substantial portions of the Software.
  14 //
  15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 // THE SOFTWARE.
  22 //
  23 //
  24
  25 #if NET_4_0
  26 using System;
  27 using System.Threading;
  28
  29 namespace System.Threading.Tasks
  30 {
  31         [System.Diagnostics.DebuggerDisplayAttribute ("ShouldExitCurrentIteration = {ShouldExitCurrentIteration}")]
  32         public class ParallelLoopState
  33         {
  34                 internal class ExternalInfos
  35                 {
  36                         public bool IsStopped;
  37                         public AtomicBooleanValue IsBroken = new AtomicBooleanValue ();
  38                         public volatile bool IsExceptional;
  39                         public long? LowestBreakIteration;
  40                 }
  41
  42                 ExternalInfos extInfos;
  43
  44                 internal ParallelLoopState (ExternalInfos extInfos)
  45                 {
  46                         this.extInfos = extInfos;
  47                 }
  48
  49                 public bool IsStopped {
  50                         get {
  51                                 return extInfos.IsStopped;
  52                         }
  53                 }
  54
  55                 public bool IsExceptional {
  56                         get {
  57                                 return extInfos.IsExceptional;
  58                         }
  59                 }
  60
  61                 public long? LowestBreakIteration {
  62                         get {
  63                                 return extInfos.LowestBreakIteration;
  64                         }
  65                 }
  66
  67                 internal int CurrentIteration {
  68                         get;
  69                         set;
  70                 }
  71
  72                 public bool ShouldExitCurrentIteration {
  73                         get {
  74                                 return IsExceptional || IsStopped;
  75                         }
  76                 }
  77
  78                 public void Break ()
  79                 {
  80                         if (extInfos.IsStopped)
  81                                 throw new InvalidOperationException ("The Stop method was previously called. Break and Stop may not be used in combination by iterations of the same loop.");
  82
  83                         bool result = extInfos.IsBroken.Exchange (true);
  84                         if (!result)
  85                                 extInfos.LowestBreakIteration = CurrentIteration;
  86                 }
  87
  88                 public void Stop ()
  89                 {
  90                         if (extInfos.IsBroken.Value)
  91                                 throw new InvalidOperationException ("The Break method was previously called. Break and Stop may not be used in combination by iterations of the same loop.");
  92                         extInfos.IsStopped = true;
  93                 }
  94         }
  95
  96 }
  97 #endif