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

   1 // PassingMessageBox.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 using System.Collections.Concurrent;
  25
  26 namespace System.Threading.Tasks.Dataflow {
  27         /// <summary>
  28         /// Message box for blocks that don't need any special processing of incoming items.
  29         /// </summary>
  30         class PassingMessageBox<TInput> : MessageBox<TInput> {
  31                 readonly Action<bool> processQueue;
  32
  33                 public PassingMessageBox (
  34                         ITargetBlock<TInput> target, BlockingCollection<TInput> messageQueue,
  35                         CompletionHelper compHelper, Func<bool> externalCompleteTester,
  36                         Action<bool> processQueue, DataflowBlockOptions dataflowBlockOptions,
  37                         bool greedy = true, Func<bool> canAccept = null)
  38                         : base (target, messageQueue, compHelper, externalCompleteTester,
  39                                 dataflowBlockOptions, greedy, canAccept)
  40                 {
  41                         this.processQueue = processQueue;
  42                 }
  43
  44                 /// <summary>
  45                 /// Makes sure the input queue is processed the way it needs to.
  46                 /// Executes synchronously, so shouldn't cause any long processing.
  47                 /// </summary>
  48                 /// <param name="newItem">Was new item just added?</param>
  49                 protected override void EnsureProcessing (bool newItem)
  50                 {
  51                         processQueue (newItem);
  52                 }
  53         }
  54 }