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                 /// <summary>
  30                 /// Cached default block options
  31                 /// </summary>
  32                 internal static DataflowBlockOptions Default {
  33                         get { return DefaultOptions; }
  34                 }
  35
  36                 public const int Unbounded = -1;
  37
  38                 int boundedCapacity;
  39                 int maxMessagesPerTask;
  40                 TaskScheduler taskScheduler;
  41                 string nameFormat;
  42
  43                 public DataflowBlockOptions ()
  44                 {
  45                         BoundedCapacity = -1;
  46                         CancellationToken = CancellationToken.None;
  47                         MaxMessagesPerTask = -1;
  48                         TaskScheduler = TaskScheduler.Default;
  49                         NameFormat = "{0} Id={1}";
  50                 }
  51
  52                 public int BoundedCapacity {
  53                         get { return boundedCapacity; }
  54                         set {
  55                                 if (value < -1)
  56                                         throw new ArgumentOutOfRangeException("value");
  57
  58                                 boundedCapacity = value;
  59                         }
  60                 }
  61
  62                 public CancellationToken CancellationToken { get; set; }
  63
  64                 public int MaxMessagesPerTask {
  65                         get { return maxMessagesPerTask; }
  66                         set {
  67                                 if (value < -1)
  68                                         throw new ArgumentOutOfRangeException("value");
  69
  70                                 maxMessagesPerTask = value;
  71                         }
  72                 }
  73
  74                 public TaskScheduler TaskScheduler {
  75                         get { return taskScheduler; }
  76                         set {
  77                                 if (value == null)
  78                                         throw new ArgumentNullException("value");
  79
  80                                 taskScheduler = value;
  81                         }
  82                 }
  83
  84                 public string NameFormat {
  85                         get { return nameFormat; }
  86                         set {
  87                                 if (value == null)
  88                                         throw new ArgumentNullException("value");
  89
  90                                 nameFormat = value;
  91                         }
  92                 }
  93         }
  94 }