mcs/class/System.Threading.Tasks.Dataflow/System.Threading.Tasks.Dataflow/DataflowBlockOptions.cs

   1 // DataflowBlockOptions.cs
   2 //
   3 // Copyright (c) 2011 Jérémie "garuma" Laval
   4 // Copyright (c) 2012 Petr Onderka
   5 //
   6 // Permission is hereby granted, free of charge, to any person obtaining a copy
   7 // of this software and associated documentation files (the "Software"), to deal
   8 // in the Software without restriction, including without limitation the rights
   9 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 // copies of the Software, and to permit persons to whom the Software is
  11 // furnished to do so, subject to the following conditions:
  12 //
  13 // The above copyright notice and this permission notice shall be included in
  14 // all copies or substantial portions of the Software.
  15 //
  16 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22 // THE SOFTWARE.
  23
  24 namespace System.Threading.Tasks.Dataflow {
  25         public class DataflowBlockOptions {
  26                 static readonly DataflowBlockOptions DefaultOptions =
  27                         new DataflowBlockOptions ();
  28
  29                 internal static DataflowBlockOptions Default {
  30                         get { return DefaultOptions; }
  31                 }
  32
  33                 public const int Unbounded = -1;
  34
  35                 int boundedCapacity;
  36                 int maxMessagesPerTask;
  37                 TaskScheduler taskScheduler;
  38                 string nameFormat;
  39
  40                 public DataflowBlockOptions ()
  41                 {
  42                         BoundedCapacity = -1;
  43                         CancellationToken = CancellationToken.None;
  44                         MaxMessagesPerTask = -1;
  45                         TaskScheduler = TaskScheduler.Default;
  46                         NameFormat = "{0} Id={1}";
  47                 }
  48
  49                 public int BoundedCapacity {
  50                         get { return boundedCapacity; }
  51                         set {
  52                                 if (value < -1)
  53                                         throw new ArgumentOutOfRangeException("value");
  54
  55                                 boundedCapacity = value;
  56                         }
  57                 }
  58
  59                 public CancellationToken CancellationToken { get; set; }
  60
  61                 public int MaxMessagesPerTask {
  62                         get { return maxMessagesPerTask; }
  63                         set {
  64                                 if (value < -1)
  65                                         throw new ArgumentOutOfRangeException("value");
  66
  67                                 maxMessagesPerTask = value;
  68                         }
  69                 }
  70
  71                 public TaskScheduler TaskScheduler {
  72                         get { return taskScheduler; }
  73                         set {
  74                                 if (value == null)
  75                                         throw new ArgumentNullException("value");
  76
  77                                 taskScheduler = value;
  78                         }
  79                 }
  80
  81                 public string NameFormat {
  82                         get { return nameFormat; }
  83                         set {
  84                                 if (value == null)
  85                                         throw new ArgumentNullException("value");
  86
  87                                 nameFormat = value;
  88                         }
  89                 }
  90         }
  91 }