Export (0) Print
Expand All

Observable.GroupByUntil(Of TSource, TKey, TElement, TDuration) Method (IObservable(Of TSource), Func(Of TSource, TKey), Func(Of TSource, TElement), Func(Of IGroupedObservable(Of TKey, TElement), IObservable(Of TDuration)), IEqualityComparer(Of TKey))

Groups the elements of an observable sequence according to a specified key selector function and comparer and selects the resulting elements by using a specified function.

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

'Declaration
<ExtensionAttribute> _
Public Shared Function GroupByUntil(Of TSource, TKey, TElement, TDuration) ( _
	source As IObservable(Of TSource), _
	keySelector As Func(Of TSource, TKey), _
	elementSelector As Func(Of TSource, TElement), _
	durationSelector As Func(Of IGroupedObservable(Of TKey, TElement), IObservable(Of TDuration)), _
	comparer As IEqualityComparer(Of TKey) _
) As IObservable(Of IGroupedObservable(Of TKey, TElement))
'Usage
Dim source As IObservable(Of TSource)
Dim keySelector As Func(Of TSource, TKey)
Dim elementSelector As Func(Of TSource, TElement)
Dim durationSelector As Func(Of IGroupedObservable(Of TKey, TElement), IObservable(Of TDuration))
Dim comparer As IEqualityComparer(Of TKey)
Dim returnValue As IObservable(Of IGroupedObservable(Of TKey, TElement))

returnValue = source.GroupByUntil(keySelector, _
	elementSelector, durationSelector, _
	comparer)

Type Parameters

TSource

The type source.

TKey

The type key.

TElement

The type element.

TDuration

The type duration.

Parameters

source
Type: System.IObservable(Of TSource)
An observable sequence whose elements to group.
keySelector
Type: System.Func(Of TSource, TKey)
A function to extract the key for each element.
elementSelector
Type: System.Func(Of TSource, TElement)
A function to map each source element to an element in an observable group.
durationSelector
Type: System.Func(Of IGroupedObservable(Of TKey, TElement), IObservable(Of TDuration))
A function to signal the expiration of a group.
comparer
Type: System.Collections.Generic.IEqualityComparer(Of TKey)
An equality comparer to compare keys with.

Return Value

Type: System.IObservable(Of IGroupedObservable(Of TKey, TElement))
A sequence of observable groups, each of which corresponds to a unique key value, containing all elements that share that same key value.

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 http://msdn.microsoft.com/en-us/library/bb384936.aspx or http://msdn.microsoft.com/en-us/library/bb383977.aspx.
Show:
© 2014 Microsoft