Export (0) Print
Expand All

Observable.Synchronize(Of TSource) Method (IObservable(Of TSource), Object)

Synchronizes the observable sequence.

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

'Declaration
<ExtensionAttribute> _
Public Shared Function Synchronize(Of TSource) ( _
	source As IObservable(Of TSource), _
	gate As Object _
) As IObservable(Of TSource)
'Usage
Dim source As IObservable(Of TSource)
Dim gate As Object
Dim returnValue As IObservable(Of TSource)

returnValue = source.Synchronize(gate)

Type Parameters

TSource

The type of source.

Parameters

source
Type: System.IObservable(Of TSource)
The source sequence.
gate
Type: System.Object
The gate object to synchronize each observer call on.

Return Value

Type: System.IObservable(Of TSource)
The source sequence whose outgoing calls to observers are synchronized on the given gate object.

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(v=vs.103).aspx or http://msdn.microsoft.com/en-us/library/bb383977(v=vs.103).aspx.

This Synchronize method returns an observable sequence of the type TSource which synchronizes outgoing calls to the observer methods (OnNext, OnCompletion, OnError). This is accomplished by acquiring a mutual-exclusion lock for the object provided as the gate parameter.

Show:
© 2014 Microsoft