IObservable<T> IObservable<T> IObservable<T> IObservable<T> Interface

Definition

Definiert einen Anbieter für Pushbenachrichtigungen.Defines a provider for push-based notification.

generic <typename T>
public interface class IObservable
public interface IObservable<out T>
type IObservable<'T> = interface
Public Interface IObservable(Of Out T)

Typparameter

T

Das Objekt, das Benachrichtigungsinformationen bereitstellt.The object that provides notification information.

Abgeleitet

Beispiele

Das folgende Beispiel veranschaulicht das Entwurfsmuster "Beobachter".The following example illustrates the observer design pattern. Definiert eine Location -Klasse, Informationen zu Breiten- und Längenkoordinaten enthält.It defines a Location class that contains latitude and longitude information.

public struct Location
{
   double lat, lon;

   public Location(double latitude, double longitude)
   {
      this.lat = latitude;
      this.lon = longitude;
   }

   public double Latitude
   { get { return this.lat; } }

   public double Longitude
   { get { return this.lon; } }
}
Public Structure Location
   Dim lat, lon As Double

   Public Sub New(ByVal latitude As Double, ByVal longitude As Double)
      Me.lat = latitude
      Me.lon = longitude
   End Sub

   Public ReadOnly Property Latitude As Double
      Get
         Return Me.lat
      End Get
   End Property

   Public ReadOnly Property Longitude As Double
      Get
         Return Me.lon
      End Get
   End Property
End Structure

Die LocationTracker -Klasse stellt die IObservable<T> Implementierung.The LocationTracker class provides the IObservable<T> implementation. Die TrackLocation -Methode übergeben eine auf NULL festlegbare Location -Objekt, das die Daten für Breiten- und Längenkoordinaten enthält.Its TrackLocation method is passed a nullable Location object that contains the latitude and longitude data. Wenn die Location Wert ist kein null, TrackLocation Methodenaufrufe der OnNext -Methode jedes Beobachters.If the Location value is not null, the TrackLocation method calls the OnNext method of each observer.

public class LocationTracker : IObservable<Location>
{
   public LocationTracker()
   {
      observers = new List<IObserver<Location>>();
   }

   private List<IObserver<Location>> observers;

   public IDisposable Subscribe(IObserver<Location> observer) 
   {
      if (! observers.Contains(observer)) 
         observers.Add(observer);
      return new Unsubscriber(observers, observer);
   }

   private class Unsubscriber : IDisposable
   {
      private List<IObserver<Location>>_observers;
      private IObserver<Location> _observer;

      public Unsubscriber(List<IObserver<Location>> observers, IObserver<Location> observer)
      {
         this._observers = observers;
         this._observer = observer;
      }

      public void Dispose()
      {
         if (_observer != null && _observers.Contains(_observer))
            _observers.Remove(_observer);
      }
   }

   public void TrackLocation(Nullable<Location> loc)
   {
      foreach (var observer in observers) {
         if (! loc.HasValue)
            observer.OnError(new LocationUnknownException());
         else
            observer.OnNext(loc.Value);
      }
   }

   public void EndTransmission()
   {
      foreach (var observer in observers.ToArray())
         if (observers.Contains(observer))
            observer.OnCompleted();

      observers.Clear();
   }
}
Public Class LocationTracker : Implements IObservable(Of Location)

   Public Sub New()
      observers = New List(Of IObserver(Of Location))
   End Sub

   Private observers As List(Of IObserver(Of Location))

   Public Function Subscribe(ByVal observer As System.IObserver(Of Location)) As System.IDisposable _
                            Implements System.IObservable(Of Location).Subscribe
      If Not observers.Contains(observer) Then
         observers.Add(observer)
      End If
      Return New Unsubscriber(observers, observer)
   End Function

   Private Class Unsubscriber : Implements IDisposable
      Private _observers As List(Of IObserver(Of Location))
      Private _observer As IObserver(Of Location)

      Public Sub New(ByVal observers As List(Of IObserver(Of Location)), ByVal observer As IObserver(Of Location))
         Me._observers = observers
         Me._observer = observer
      End Sub

      Public Sub Dispose() Implements IDisposable.Dispose
         If _observer IsNot Nothing AndAlso _observers.Contains(_observer) Then
            _observers.Remove(_observer)
         End If
      End Sub
   End Class

   Public Sub TrackLocation(ByVal loc As Nullable(Of Location))
      For Each observer In observers
         If Not loc.HasValue Then
            observer.OnError(New LocationUnknownException())
         Else
            observer.OnNext(loc.Value)
         End If
      Next
   End Sub

   Public Sub EndTransmission()
      For Each observer In observers.ToArray()
         If observers.Contains(observer) Then observer.OnCompleted()
      Next
      observers.Clear()
   End Sub
End Class

Wenn die Location Wert null, TrackLocation Methode instanziiert ein LocationUnknownException -Objekt, das im folgenden Beispiel gezeigt wird.If the Location value is null, the TrackLocation method instantiates a LocationUnknownException object, which is shown in the following example. Es ruft dann jedes Beobachters OnError Methode und übergibt es die LocationUnknownException Objekt.It then calls each observer's OnError method and passes it the LocationUnknownException object. Beachten Sie, dass LocationUnknownException leitet sich von Exception, aber keine neue Member hinzugefügt wird.Note that LocationUnknownException derives from Exception, but does not add any new members.

public class LocationUnknownException : Exception
{
   internal LocationUnknownException() 
   { }
}
Public Class LocationUnknownException : Inherits Exception
   Friend Sub New()
   End Sub
End Class

Beobachter registrieren sich für die Benachrichtigungen aus einer TrackLocation -Objekt durch Aufrufen der IObservable<T>.Subscribe -Methode, die einen Verweis auf das Observer-Objekt, einen privaten generischen weist List<T> Objekt.Observers register to receive notifications from a TrackLocation object by calling its IObservable<T>.Subscribe method, which assigns a reference to the observer object to a private generic List<T> object. Die Methode gibt ein Unsubscriber -Objekt, das ist ein IDisposable -Implementierung, die Beobachter den Empfang von Benachrichtigungen beenden kann.The method returns an Unsubscriber object, which is an IDisposable implementation that enables observers to stop receiving notifications. Die LocationTracker -Klasse enthält auch eine EndTransmission Methode.The LocationTracker class also includes an EndTransmission method. Wenn keine weiteren Daten verfügbar ist, ruft die-Methode jedes Beobachters OnCompleted Methode und löscht dann die interne Liste der Beobachter.When no further location data is available, the method calls each observer's OnCompleted method and then clears the internal list of observers.

In diesem Beispiel die LocationReporter -Klasse stellt die IObserver<T> Implementierung.In this example, the LocationReporter class provides the IObserver<T> implementation. Es zeigt Informationen zu den aktuellen Speicherort, an die Konsole.It displays information about the current location to the console. Der Konstruktor schließt eine name -Parameter, der ermöglicht die LocationReporter Instanz sich in die Zeichenfolgenausgabe identifiziert.Its constructor includes a name parameter, which enables the LocationReporter instance to identify itself in its string output. Es enthält auch eine Subscribe -Methode, die einen Aufruf des Anbieters umschließt Subscribe Methode.It also includes a Subscribe method, which wraps a call to the provider's Subscribe method. Dadurch wird die Methode, weisen Sie den zurückgegebenen IDisposable Verweis auf eine private Variable.This allows the method to assign the returned IDisposable reference to a private variable. Die LocationReporter -Klasse enthält auch eine Unsubscribe -Methode, die Aufrufe der IDisposable.Dispose -Methode des Objekts, die von zurückgegeben wird die IObservable<T>.Subscribe Methode.The LocationReporter class also includes an Unsubscribe method, which calls the IDisposable.Dispose method of the object that is returned by the IObservable<T>.Subscribe method. Der folgende Code definiert die LocationReporter Klasse.The following code defines the LocationReporter class.

using System;

public class LocationReporter : IObserver<Location>
{
   private IDisposable unsubscriber;
   private string instName;

   public LocationReporter(string name)
   {
      this.instName = name;
   }

   public string Name
   {  get{ return this.instName; } }

   public virtual void Subscribe(IObservable<Location> provider)
   {
      if (provider != null) 
         unsubscriber = provider.Subscribe(this);
   }

   public virtual void OnCompleted()
   {
      Console.WriteLine("The Location Tracker has completed transmitting data to {0}.", this.Name);
      this.Unsubscribe();
   }

   public virtual void OnError(Exception e)
   {
      Console.WriteLine("{0}: The location cannot be determined.", this.Name);
   }

   public virtual void OnNext(Location value)
   {
      Console.WriteLine("{2}: The current location is {0}, {1}", value.Latitude, value.Longitude, this.Name);
   }

   public virtual void Unsubscribe()
   {
      unsubscriber.Dispose();
   }
}
Public Class LocationReporter : Implements IObserver(Of Location)
   Dim unsubscriber As IDisposable
   Dim instName As String

   Public Sub New(ByVal name As String)
      Me.instName = name
   End Sub

   Public ReadOnly Property Name As String
      Get
         Return instName
      End Get
   End Property

   Public Overridable Sub Subscribe(ByVal provider As IObservable(Of Location))
      If provider Is Nothing Then Exit Sub
      unsubscriber = provider.Subscribe(Me)
   End Sub

   Public Overridable Sub OnCompleted() Implements System.IObserver(Of Location).OnCompleted
      Console.WriteLine("The Location Tracker has completed transmitting data to {0}.", Me.Name)
      Me.Unsubscribe()
   End Sub

   Public Overridable Sub OnError(ByVal e As System.Exception) Implements System.IObserver(Of Location).OnError
      Console.WriteLine("{0}: The location cannot be determined.", Me.Name)
   End Sub

   Public Overridable Sub OnNext(ByVal value As Location) Implements System.IObserver(Of Location).OnNext
      Console.WriteLine("{2}: The current location is {0}, {1}", value.Latitude, value.Longitude, Me.Name)
   End Sub

   Public Overridable Sub Unsubscribe()
      unsubscriber.Dispose()
   End Sub
End Class

Klicken Sie dann instanziiert der folgende Code, den Anbieter und der Beobachter.The following code then instantiates the provider and the observer.

using System;

class Program
{
   static void Main(string[] args)
   {
      // Define a provider and two observers.
      LocationTracker provider = new LocationTracker();
      LocationReporter reporter1 = new LocationReporter("FixedGPS");
      reporter1.Subscribe(provider);
      LocationReporter reporter2 = new LocationReporter("MobileGPS");
      reporter2.Subscribe(provider);

      provider.TrackLocation(new Location(47.6456, -122.1312));
      reporter1.Unsubscribe();
      provider.TrackLocation(new Location(47.6677, -122.1199));
      provider.TrackLocation(null);
      provider.EndTransmission();
   }
}
// The example displays output similar to the following:
//      FixedGPS: The current location is 47.6456, -122.1312
//      MobileGPS: The current location is 47.6456, -122.1312
//      MobileGPS: The current location is 47.6677, -122.1199
//      MobileGPS: The location cannot be determined.
//      The Location Tracker has completed transmitting data to MobileGPS.
Module Module1
   Dim provider As LocationTracker

   Sub Main()
      ' Define a provider and two observers.
      provider = New LocationTracker()
      Dim reporter1 As New LocationReporter("FixedGPS")
      reporter1.Subscribe(provider)
      Dim reporter2 As New LocationReporter("MobileGPS")
      reporter2.Subscribe(provider)

      provider.TrackLocation(New Location(47.6456, -122.1312))
      reporter1.Unsubscribe()
      provider.TrackLocation(New Location(47.6677, -122.1199))
      provider.TrackLocation(Nothing)
      provider.EndTransmission()
   End Sub
End Module
' The example displays output similar to the following:
'       FixedGPS: The current location is 47.6456, -122.1312
'       MobileGPS: The current location is 47.6456, -122.1312
'       MobileGPS: The current location is 47.6677, -122.1199
'       MobileGPS: The location cannot be determined.
'       The Location Tracker has completed transmitting data to MobileGPS.

Hinweise

Die IObserver<T> und IObservable<T> Schnittstellen bieten einen generalisierten Mechanismus für Pushbenachrichtigungen, auch bekannt als das Entwurfsmuster "Beobachter".The IObserver<T> and IObservable<T> interfaces provide a generalized mechanism for push-based notification, also known as the observer design pattern. Die IObservable<T> Schnittstelle stellt die Klasse dar, das Benachrichtigungen (der Anbieter), sendet der IObserver<T> -Schnittstelle stellt die Klasse, die sie (der Beobachter) empfängt.The IObservable<T> interface represents the class that sends notifications (the provider); the IObserver<T> interface represents the class that receives them (the observer). T Stellt die Klasse, die die Benachrichtigungsinformationen bereitstellt.T represents the class that provides the notification information. In einigen pushbasierte Benachrichtigungen die IObserver<T> Implementierung und T denselben Typ darstellen kann.In some push-based notifications, the IObserver<T> implementation and T can represent the same type.

Der Anbieter muss eine einzelne Methode, implementieren Subscribe, das angibt, dass ein Beobachter pushbasierte Benachrichtigungen empfangen werden sollen.The provider must implement a single method, Subscribe, that indicates that an observer wants to receive push-based notifications. Aufrufer der Methode übergeben, eine Instanz der Beobachter.Callers to the method pass an instance of the observer. Die Methode gibt ein IDisposable -Implementierung, die das Beobachtern erlaubt, Benachrichtigungen zu einem beliebigen Zeitpunkt aus, bevor Sie der Anbieter senden beendet wurde abgebrochen.The method returns an IDisposable implementation that enables observers to cancel notifications at any time before the provider has stopped sending them.

Zu jedem Zeitpunkt möglicherweise ein angegebenen Anbieter 0 (null), ein oder mehrere Observer-Objekte.At any given time, a given provider may have zero, one, or multiple observers. Der Anbieter ist verantwortlich für das Speichern Verweise auf Observer, und sicherstellen, dass sie gültig sind, bevor die Benachrichtigungen gesendet.The provider is responsible for storing references to observers and ensuring that they are valid before it sends notifications. Die IObservable<T> Schnittstelle ist keine Annahmen über die Anzahl der Beobachter oder die Reihenfolge, in denen Benachrichtigungen gesendet werden.The IObservable<T> interface does not make any assumptions about the number of observers or the order in which notifications are sent.

Der Anbieter sendet die folgenden drei Arten von Benachrichtigungen an den Beobachter, durch den Aufruf IObserver<T> Methoden:The provider sends the following three kinds of notifications to the observer by calling IObserver<T> methods:

  • Die aktuellen Daten.The current data. Der Anbieter kann Aufrufen der IObserver<T>.OnNext Methode, um den Beobachter übergeben eine T -Objekt, das aktuelle Daten, die geänderten Daten oder neue Daten enthält.The provider can call the IObserver<T>.OnNext method to pass the observer a T object that has current data, changed data, or fresh data.

  • Eine fehlerbedingung.An error condition. Der Anbieter kann Aufrufen der IObserver<T>.OnError Methode, um den Beobachter zu informieren, die eine fehlerbedingung aufgetreten ist.The provider can call the IObserver<T>.OnError method to notify the observer that some error condition has occurred.

  • Keine weiteren Daten.No further data. Der Anbieter kann Aufrufen der IObserver<T>.OnCompleted Methode, um dem Beobachter zu benachrichtigen, dass er mit dem Senden von Benachrichtigungen abgeschlossen hat.The provider can call the IObserver<T>.OnCompleted method to notify the observer that it has finished sending notifications.

Methoden

Subscribe(IObserver<T>) Subscribe(IObserver<T>) Subscribe(IObserver<T>) Subscribe(IObserver<T>)

Benachrichtigt den Anbieter, dass ein Beobachter Benachrichtigungen empfangen soll.Notifies the provider that an observer is to receive notifications.

Gilt für:

Siehe auch