Class Timeout

Namespace

Bonsai.Reactive

Assembly

Bonsai.Core.dll

Represents an operator that raises an error if the next element is not received within the specified timeout duration from the previous element.

Time zero is the start of the sequence (i.e. the moment of subscription). If a new notification arrives before a timeout is reached, the clock is reset.

public class Timeout : Combinator

Inheritance

object

Combinator

Timeout

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

DueTime

Gets or sets the maximum duration between values before a timeout occurs.

public TimeSpan DueTime { get; set; }

Property Value

TimeSpan

Methods

Process<TSource>(IObservable<TSource>)

Applies a timeout policy for each element in the observable sequence. If the next element is not received within the specified timeout duration from the previous element, a TimeoutException is propagated to the observer.

public override IObservable<TSource> Process<TSource>(IObservable<TSource> source)

Parameters

source IObservable<TSource>

The source sequence to perform a timeout for.

Returns

IObservable<TSource>

A sequence which is identical to the source sequence, but where a TimeoutException is raised if more than the specified timout duration lapses between consecutive elements.

Type Parameters

TSource

The type of the elements in the source sequence.