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

   1 // JoinBlock.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         /// Target block use by join blocks in their TargetN properties.
  29         /// Also serves as its own <see cref="MessageBox{TInput}"/>.
  30         /// </summary>
  31         class JoinTarget<TTarget> : MessageBox<TTarget>, ITargetBlock<TTarget> {
  32                 readonly IDataflowBlock joinBlock;
  33                 readonly Action signal;
  34
  35                 public JoinTarget (
  36                         IDataflowBlock joinBlock, Action signal, CompletionHelper helper,
  37                         Func<bool> externalCompleteTester, DataflowBlockOptions options,
  38                         bool greedy, Func<bool> canAccept)
  39                         : base (null, new BlockingCollection<TTarget> (), helper, externalCompleteTester,
  40                                 options, greedy, canAccept)
  41                 {
  42                         this.joinBlock = joinBlock;
  43                         this.signal = signal;
  44                         Target = this;
  45                 }
  46
  47                 /// <summary>
  48                 /// Makes sure the input queue is processed the way it needs to,
  49                 /// by signaling the parent join block.
  50                 /// </summary>
  51                 protected override void EnsureProcessing (bool newItem)
  52                 {
  53                         signal ();
  54                 }
  55
  56                 /// <summary>
  57                 /// The input queue of this block.
  58                 /// </summary>
  59                 public BlockingCollection<TTarget> Buffer {
  60                         get { return MessageQueue; }
  61                 }
  62
  63                 DataflowMessageStatus ITargetBlock<TTarget>.OfferMessage (
  64                         DataflowMessageHeader messageHeader, TTarget messageValue,
  65                         ISourceBlock<TTarget> source, bool consumeToAccept)
  66                 {
  67                         return OfferMessage (messageHeader, messageValue, source, consumeToAccept);
  68                 }
  69
  70                 void IDataflowBlock.Complete ()
  71                 {
  72                         Complete ();
  73                 }
  74
  75                 Task IDataflowBlock.Completion {
  76                         get { throw new NotSupportedException (); }
  77                 }
  78
  79                 void IDataflowBlock.Fault (Exception exception)
  80                 {
  81                         joinBlock.Fault (exception);
  82                 }
  83         }
  84 }