如何取消可观察序列

Question

我有一个非常简单的 IObservable，每 500 毫秒充当一个脉冲发生器：

var pulses = Observable.GenerateWithTime(0, i => true, i => i + 1, i => i,
                                         i => TimeSpan.FromMilliseconds(500))

我有一个 CancellationTokenSource （用于取消同时进行的其他工作）。

如何使用取消令牌源来取消我的可观察序列？

Answer 1

这是一个旧线程，但仅供将来参考，这里有一个更简单的方法。

如果您有 CancellationToken，则您可能已经在处理任务了。因此，只需将其转换为任务并让框架进行绑定：

using System.Reactive.Threading.Tasks;
...
var task = myObservable.ToTask(cancellationToken);

这将创建一个内部订阅者，该订阅者将在任务取消时被释放。这在大多数情况下都会起作用，因为大多数可观察量仅在有订阅者时才产生值。

现在，如果您有一个实际的可观察量由于某种原因需要处置（如果父任务被取消，也许一个热可观察量不再重要），这可以通过延续来实现：

disposableObservable.ToTask(cancellationToken).ContinueWith(t => {
    if (t.Status == TaskStatus.Canceled)
        disposableObservable.Dispose();
});

Answer 2

如果您使用的是GenerateWithTime（现在替换为传入时间跨度函数重载的Generate），您可以替换第二个参数来评估取消令牌的状态，如下所示：

var pulses = Observable.Generate(0,
    i => !ts.IsCancellationRequested,
    i => i + 1,
    i => i,
    i => TimeSpan.FromMilliseconds(500));

或者，如果您的事件导致取消令牌被设置可以转换为可观察本身，您可以使用类似以下内容：

pulses.TakeUntil(CancelRequested);

我在 http://www.thinqlinq.com/Post.aspx/Title /Cancelling-a-Reactive-Extensions-Observable 也是如此。

Answer 3

这里有两个方便的运算符，用于取消可观察的序列。它们之间的区别在于取消时会发生什么。 TakeUntil 导致序列正常完成 (OnCompleted)，而 WithCancellation 导致异常终止 (OnError) ）。

/// <summary>Returns the elements from the source observable sequence until the
/// CancellationToken is canceled.</summary>
public static IObservable<TSource> TakeUntil<TSource>(
    this IObservable<TSource> source, CancellationToken cancellationToken)
{
    return source
        .TakeUntil(Observable.Create<Unit>(observer =>
            cancellationToken.Register(() => observer.OnNext(default))));
}

/// <summary>Ties a CancellationToken to an observable sequence. In case of
/// cancellation propagates an OperationCanceledException to the observer.</summary>
public static IObservable<TSource> WithCancellation<TSource>(
    this IObservable<TSource> source, CancellationToken cancellationToken)
{
    return source
        .TakeUntil(Observable.Create<Unit>(o => cancellationToken.Register(() =>
            o.OnError(new OperationCanceledException(cancellationToken)))));
}

使用示例：

var cts = new CancellationTokenSource(TimeSpan.FromSeconds(30));

var pulses = Observable
    .Generate(0, i => true, i => i + 1, i => i, i => TimeSpan.FromMilliseconds(500))
    .WithCancellation(cts.Token);

---

注意：如果取消，上面提供的自定义运算符将立即取消订阅底层可观察量。如果可观察到的结果包含副作用，则需要考虑这一点。将 TakeUntil(cts.Token) 放在执行副作用的运算符之前将推迟整个可观察量的完成，直到副作用完成（优雅终止）。将其放在副作用之后将使取消立即发生，从而可能导致任何正在运行的代码以“即发即忘”的方式继续运行而不被观察到。

Answer 4

您可以使用以下代码片段将您的 IObservable 订阅与 CancellationTokenSource 连接起来

var pulses = Observable.GenerateWithTime(0,
    i => true, i => i + 1, i => i,
    i => TimeSpan.FromMilliseconds(500));

// Get your CancellationTokenSource
CancellationTokenSource ts = ...

// Subscribe
ts.Token.Register(pulses.Subscribe(...).Dispose);

Answer 5

您可以通过订阅获取一个 IDisposable 实例。对此调用 Dispose() 。