Observable.Sample(Of TSource) Method (IObservable(Of TSource), TimeSpan, IScheduler)

Samples the observable sequence at each interval with the specified source, interval and scheduler.

Namespace:  System.Reactive.Linq
Assembly:  System.Reactive (in System.Reactive.dll)

'Declaration
<ExtensionAttribute> _
Public Shared Function Sample(Of TSource) ( _
	source As IObservable(Of TSource), _
	interval As TimeSpan, _
	scheduler As IScheduler _
) As IObservable(Of TSource)
'Usage
Dim source As IObservable(Of TSource)
Dim interval As TimeSpan
Dim scheduler As IScheduler
Dim returnValue As IObservable(Of TSource)

returnValue = source.Sample(interval, _
	scheduler)

Type Parameters

TSource

The type of source.

Parameters

source
Type: System.IObservable(Of TSource)
The source sequence to sample.
interval
Type: System.TimeSpan
The interval at which to sample.
scheduler
Type: System.Reactive.Concurrency.IScheduler
The scheduler to run the sampling timer on.

Return Value

Type: System.IObservable(Of TSource)
The sampled observable sequence.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IObservable(Of TSource). When you use instance method syntax to call this method, omit the first parameter. For more information, see https://msdn.microsoft.com/en-us/library/bb384936(v=vs.103).aspx or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.103).aspx.
Show: