linux-packaging-mono/mcs/class/System.Threading.Tasks.Dataflow/System.Threading.Tasks.Dataflow/TransformManyBlock.cs

// TransformManyBlock.cs
//
// Copyright (c) 2011 Jérémie "garuma" Laval
// Copyright (c) 2012 Petr Onderka
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System.Collections.Generic;
using System.Collections.Concurrent;

namespace System.Threading.Tasks.Dataflow {
	public sealed class TransformManyBlock<TInput, TOutput> :
		IPropagatorBlock<TInput, TOutput>, IReceivableSourceBlock<TOutput> {
		readonly CompletionHelper compHelper;
		readonly BlockingCollection<TInput> messageQueue = new BlockingCollection<TInput> ();
		readonly MessageBox<TInput> messageBox;
		readonly ExecutionDataflowBlockOptions dataflowBlockOptions;
		readonly Func<TInput, IEnumerable<TOutput>> transform;
		readonly Func<TInput, Task<IEnumerable<TOutput>>> asyncTransform;
		readonly OutgoingQueue<TOutput> outgoing;

		TransformManyBlock (ExecutionDataflowBlockOptions dataflowBlockOptions)
		{
			if (dataflowBlockOptions == null)
				throw new ArgumentNullException ("dataflowBlockOptions");
			
			this.dataflowBlockOptions = dataflowBlockOptions;
			this.compHelper = new CompletionHelper (dataflowBlockOptions);
		}

		public TransformManyBlock (Func<TInput, IEnumerable<TOutput>> transform)
			: this (transform, ExecutionDataflowBlockOptions.Default)
		{
		}

		public TransformManyBlock (Func<TInput, IEnumerable<TOutput>> transform,
		                           ExecutionDataflowBlockOptions dataflowBlockOptions)
			: this (dataflowBlockOptions)
		{
			if (transform == null)
				throw new ArgumentNullException ("transform");

			this.transform = transform;
			this.messageBox = new ExecutingMessageBox<TInput> (this, messageQueue, compHelper,
				() => outgoing.IsCompleted, TransformProcess, () => outgoing.Complete (),
				dataflowBlockOptions);
			this.outgoing = new OutgoingQueue<TOutput> (this, compHelper,
				() => messageQueue.IsCompleted, messageBox.DecreaseCount,
				dataflowBlockOptions);
		}

		public TransformManyBlock (Func<TInput, Task<IEnumerable<TOutput>>> transform)
			: this (transform, ExecutionDataflowBlockOptions.Default)
		{
		}

		public TransformManyBlock (Func<TInput, Task<IEnumerable<TOutput>>> transform,
		                           ExecutionDataflowBlockOptions dataflowBlockOptions)
			: this (dataflowBlockOptions)
		{
			if (transform == null)
				throw new ArgumentNullException ("transform");

			this.asyncTransform = transform;
			this.messageBox = new AsyncExecutingMessageBox<TInput, Task<IEnumerable<TOutput>>> (this, messageQueue, compHelper,
				() => outgoing.IsCompleted, AsyncTransformProcess, ProcessFinishedTask, () => outgoing.Complete (),
				dataflowBlockOptions);
			this.outgoing = new OutgoingQueue<TOutput> (this, compHelper,
				() => messageQueue.IsCompleted, messageBox.DecreaseCount,
				dataflowBlockOptions);			
		}

		DataflowMessageStatus ITargetBlock<TInput>.OfferMessage (
			DataflowMessageHeader messageHeader, TInput messageValue,
			ISourceBlock<TInput> source, bool consumeToAccept)
		{
			return messageBox.OfferMessage (messageHeader, messageValue, source, consumeToAccept);
		}

		public IDisposable LinkTo (ITargetBlock<TOutput> target, DataflowLinkOptions linkOptions)
		{
			return outgoing.AddTarget (target, linkOptions);
		}

		TOutput ISourceBlock<TOutput>.ConsumeMessage (
			DataflowMessageHeader messageHeader, ITargetBlock<TOutput> target,
			out bool messageConsumed)
		{
			return outgoing.ConsumeMessage (messageHeader, target, out messageConsumed);
		}

		void ISourceBlock<TOutput>.ReleaseReservation (
			DataflowMessageHeader messageHeader, ITargetBlock<TOutput> target)
		{
			outgoing.ReleaseReservation (messageHeader, target);
		}

		bool ISourceBlock<TOutput>.ReserveMessage (
			DataflowMessageHeader messageHeader, ITargetBlock<TOutput> target)
		{
			return outgoing.ReserveMessage (messageHeader, target);
		}

		public bool TryReceive (Predicate<TOutput> filter, out TOutput item)
		{
			return outgoing.TryReceive (filter, out item);
		}

		public bool TryReceiveAll (out IList<TOutput> items)
		{
			return outgoing.TryReceiveAll (out items);
		}

		/// <summary>
		/// Transforms one item from the queue if the transform delegate is synchronous.
		/// </summary>
		/// <returns>Returns whether an item was processed. Returns <c>false</c> if the queue is empty.</returns>
		bool TransformProcess ()
		{
			TInput input;

			var dequeued = messageQueue.TryTake (out input);
			if (dequeued) {
				var result = transform (input);

				EnqueueTransformed (result);
			}

			return dequeued;
		}

		/// <summary>
		/// Adds the transformed collection to the output queue.
		/// </summary>
		void EnqueueTransformed (IEnumerable<TOutput> transformed)
		{
			bool first = true;
			if (transformed != null) {
				foreach (var item in transformed) {
					if (first)
						first = false;
					else
						messageBox.IncreaseCount ();
					outgoing.AddData (item);
				}
			}
			if (first)
				messageBox.DecreaseCount ();
		}

		/// <summary>
		/// Processes one item from the queue if the transform delegate is asynchronous.
		/// </summary>
		/// <param name="task">The Task that was returned by the synchronous part of the delegate.</param>
		/// <returns>Returns whether an item was processed. Returns <c>false</c> if the queue was empty.</returns>
		bool AsyncTransformProcess (out Task<IEnumerable<TOutput>> task)
		{
			TInput input;

			var dequeued = messageQueue.TryTake (out input);
			if (dequeued)
				task = asyncTransform (input);
			else
				task = null;

			return dequeued;
		}

		/// <summary>
		/// Process result of finished asynchronous transformation.
		/// </summary>
		void ProcessFinishedTask (Task<IEnumerable<TOutput>> task)
		{
			if (task == null || task.IsCanceled)
				messageBox.DecreaseCount ();
			else
				EnqueueTransformed (task.Result);
		}

		public void Complete ()
		{
			messageBox.Complete ();
		}

		void IDataflowBlock.Fault (Exception exception)
		{
			compHelper.RequestFault (exception);
		}

		public Task Completion {
			get { return compHelper.Completion; }
		}

		public int OutputCount {
			get { return outgoing.Count; }
		}

		public int InputCount {
			get { return messageQueue.Count; }
		}

		public override string ToString ()
		{
			return NameHelper.GetName (this, dataflowBlockOptions);
		}
	}
}