1 // DataflowBlockOptions.cs
3 // Copyright (c) 2011 Jérémie "garuma" Laval
4 // Copyright (c) 2012 Petr Onderka
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:
13 // The above copyright notice and this permission notice shall be included in
14 // all copies or substantial portions of the Software.
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
24 namespace System.Threading.Tasks.Dataflow {
25 public class DataflowBlockOptions {
26 static readonly DataflowBlockOptions DefaultOptions =
27 new DataflowBlockOptions ();
30 /// Cached default block options
32 internal static DataflowBlockOptions Default {
33 get { return DefaultOptions; }
36 public const int Unbounded = -1;
39 int maxMessagesPerTask;
40 TaskScheduler taskScheduler;
43 public DataflowBlockOptions ()
46 CancellationToken = CancellationToken.None;
47 MaxMessagesPerTask = -1;
48 TaskScheduler = TaskScheduler.Default;
49 NameFormat = "{0} Id={1}";
52 public int BoundedCapacity {
53 get { return boundedCapacity; }
56 throw new ArgumentOutOfRangeException("value");
58 boundedCapacity = value;
62 public CancellationToken CancellationToken { get; set; }
64 public int MaxMessagesPerTask {
65 get { return maxMessagesPerTask; }
68 throw new ArgumentOutOfRangeException("value");
70 maxMessagesPerTask = value;
74 public TaskScheduler TaskScheduler {
75 get { return taskScheduler; }
78 throw new ArgumentNullException("value");
80 taskScheduler = value;
84 public string NameFormat {
85 get { return nameFormat; }
88 throw new ArgumentNullException("value");