// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information. #if !NO_TPL using System.Reactive.Disposables; using System.Threading.Tasks; using System.Threading; using System.Reactive.Linq; using System.Reactive.Subjects; namespace System.Reactive.Threading.Tasks { /// /// Provides a set of static methods for converting tasks to observable sequences. /// public static class TaskObservableExtensions { /// /// Returns an observable sequence that signals when the task completes. /// /// Task to convert to an observable sequence. /// An observable sequence that produces a unit value when the task completes, or propagates the exception produced by the task. /// is null. /// If the specified task object supports cancellation, consider using instead. public static IObservable ToObservable(this Task task) { if (task == null) throw new ArgumentNullException("task"); var subject = new AsyncSubject(); if (task.IsCompleted) { ToObservableDone(task, subject); } else { ToObservableSlow(task, subject); } return subject.AsObservable(); } private static void ToObservableSlow(Task task, AsyncSubject subject) { // // Separate method to avoid closure in synchronous completion case. // task.ContinueWith(t => ToObservableDone(task, subject)); } private static void ToObservableDone(Task task, AsyncSubject subject) { switch (task.Status) { case TaskStatus.RanToCompletion: subject.OnNext(Unit.Default); subject.OnCompleted(); break; case TaskStatus.Faulted: subject.OnError(task.Exception.InnerException); break; case TaskStatus.Canceled: subject.OnError(new TaskCanceledException(task)); break; } } /// /// Returns an observable sequence that propagates the result of the task. /// /// The type of the result produced by the task. /// Task to convert to an observable sequence. /// An observable sequence that produces the task's result, or propagates the exception produced by the task. /// is null. /// If the specified task object supports cancellation, consider using instead. public static IObservable ToObservable(this Task task) { if (task == null) throw new ArgumentNullException("task"); var subject = new AsyncSubject(); if (task.IsCompleted) { ToObservableDone(task, subject); } else { ToObservableSlow(task, subject); } return subject.AsObservable(); } private static void ToObservableSlow(Task task, AsyncSubject subject) { // // Separate method to avoid closure in synchronous completion case. // task.ContinueWith(t => ToObservableDone(t, subject)); } private static void ToObservableDone(Task task, AsyncSubject subject) { switch (task.Status) { case TaskStatus.RanToCompletion: subject.OnNext(task.Result); subject.OnCompleted(); break; case TaskStatus.Faulted: subject.OnError(task.Exception.InnerException); break; case TaskStatus.Canceled: subject.OnError(new TaskCanceledException(task)); break; } } /// /// Returns a task that will receive the last value or the exception produced by the observable sequence. /// /// The type of the elements in the source sequence. /// Observable sequence to convert to a task. /// A task that will receive the last element or the exception produced by the observable sequence. /// is null. public static Task ToTask(this IObservable observable) { if (observable == null) throw new ArgumentNullException("observable"); return observable.ToTask(new CancellationToken(), null); } /// /// Returns a task that will receive the last value or the exception produced by the observable sequence. /// /// The type of the elements in the source sequence. /// Observable sequence to convert to a task. /// The state to use as the underlying task's AsyncState. /// A task that will receive the last element or the exception produced by the observable sequence. /// is null. public static Task ToTask(this IObservable observable, object state) { if (observable == null) throw new ArgumentNullException("observable"); return observable.ToTask(new CancellationToken(), state); } /// /// Returns a task that will receive the last value or the exception produced by the observable sequence. /// /// The type of the elements in the source sequence. /// Observable sequence to convert to a task. /// Cancellation token that can be used to cancel the task, causing unsubscription from the observable sequence. /// A task that will receive the last element or the exception produced by the observable sequence. /// is null. public static Task ToTask(this IObservable observable, CancellationToken cancellationToken) { if (observable == null) throw new ArgumentNullException("observable"); return observable.ToTask(cancellationToken, null); } /// /// Returns a task that will receive the last value or the exception produced by the observable sequence. /// /// The type of the elements in the source sequence. /// Observable sequence to convert to a task. /// Cancellation token that can be used to cancel the task, causing unsubscription from the observable sequence. /// The state to use as the underlying task's AsyncState. /// A task that will receive the last element or the exception produced by the observable sequence. /// is null. public static Task ToTask(this IObservable observable, CancellationToken cancellationToken, object state) { if (observable == null) throw new ArgumentNullException("observable"); var hasValue = false; var lastValue = default(TResult); var tcs = new TaskCompletionSource(state); var disposable = new SingleAssignmentDisposable(); var ctr = default(CancellationTokenRegistration); if (cancellationToken.CanBeCanceled) { ctr = cancellationToken.Register(() => { disposable.Dispose(); tcs.TrySetCanceled(cancellationToken); }); } var taskCompletionObserver = new AnonymousObserver( value => { hasValue = true; lastValue = value; }, ex => { tcs.TrySetException(ex); ctr.Dispose(); // no null-check needed (struct) disposable.Dispose(); }, () => { if (hasValue) tcs.TrySetResult(lastValue); else tcs.TrySetException(new InvalidOperationException(Strings_Linq.NO_ELEMENTS)); ctr.Dispose(); // no null-check needed (struct) disposable.Dispose(); } ); // // Subtle race condition: if the source completes before we reach the line below, the SingleAssigmentDisposable // will already have been disposed. Upon assignment, the disposable resource being set will be disposed on the // spot, which may throw an exception. (Similar to TFS 487142) // try { // // [OK] Use of unsafe Subscribe: we're catching the exception here to set the TaskCompletionSource. // // Notice we could use a safe subscription to route errors through OnError, but we still need the // exception handling logic here for the reason explained above. We cannot afford to throw here // and as a result never set the TaskCompletionSource, so we tunnel everything through here. // disposable.Disposable = observable.Subscribe/*Unsafe*/(taskCompletionObserver); } catch (Exception ex) { tcs.TrySetException(ex); } return tcs.Task; } } } #endif