IObservable<T>.Subscribe Method
March 22, 2012
Subscribes observer to receive notifications.
Assembly: System.Observable (in System.Observable.dll)
Parameters
- observer
- Type: System.IObserver<T>
The object that is to receive notifications.
Return Value
Type: System.IDisposableA reference to an interface that allows observers to stop receiving notifications before the provider has finished sending them.
The Subscribe method must be called to register an observer for push-based notifications. A typical implementation of the Subscribe method does the following:
-
It stores a reference to the observer in a collection object, such as a List<T> object.
-
It returns a reference to an IDisposable interface. This enables observers to unsubscribe (that is, to stop receiving notifications) before the provider has finished sending them and called the subscriber's OnCompleted method.
At any given time, a particular instance of an IObservable<T> implementation is responsible for handling all subscriptions and notifying all subscribers. Unless the documentation for a particular IObservable<T> implementation indicates otherwise, observers should make no assumptions about the IObservable<T> implementation, such as the order of notifications that multiple observers will receive.
