Observable.Timeout<TSource> Method (IObservable<TSource>, TimeSpan, IScheduler)
Returns either the observable sequence or an TimeoutException if dueTime elapses.
Namespace: System.Reactive.Linq
Assembly: System.Reactive (in System.Reactive.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function Timeout(Of TSource) ( _
source As IObservable(Of TSource), _
dueTime As TimeSpan, _
scheduler As IScheduler _
) As IObservable(Of TSource)
'Usage
Dim source As IObservable(Of TSource)
Dim dueTime As TimeSpan
Dim scheduler As IScheduler
Dim returnValue As IObservable(Of TSource)
returnValue = source.Timeout(dueTime, _
scheduler)
public static IObservable<TSource> Timeout<TSource>(
this IObservable<TSource> source,
TimeSpan dueTime,
IScheduler scheduler
)
[ExtensionAttribute]
public:
generic<typename TSource>
static IObservable<TSource>^ Timeout(
IObservable<TSource>^ source,
TimeSpan dueTime,
IScheduler^ scheduler
)
static member Timeout :
source:IObservable<'TSource> *
dueTime:TimeSpan *
scheduler:IScheduler -> IObservable<'TSource>
JScript does not support generic types and methods.
Type Parameters
- TSource
The type source.
Parameters
- source
Type: System.IObservable<TSource>
The source sequence to perform a timeout for.
- dueTime
Type: System.TimeSpan
The maximum duration between values before a timeout occurs.
- scheduler
Type: System.Reactive.Concurrency.IScheduler
The scheduler to run the timeout timers on.
Return Value
Type: System.IObservable<TSource>
The source sequence with a TimeoutException in case of a timeout.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type IObservable<TSource>. When you use instance method syntax to call this method, omit the first parameter. For more information, see or .