IObservable<T> Schnittstelle

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

Im folgenden Beispiel wird das Observer-Entwurfsmuster veranschaulicht.The following example illustrates the observer design pattern. Es definiert eine Location Klasse, die Informationen zu breiten-und Längengrad 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 IObservable<T> die-Implementierung bereit.The LocationTracker class provides the IObservable<T> implementation. An die zugehörige- Location MethodewirdeinObjekt,dasNULL-Wertezulässt,mitdenbreiten-undLängengradDatenTrackLocationIts TrackLocation method is passed a nullable Location object that contains the latitude and longitude data. Wenn der Location Wert nicht nullist, ruft TrackLocation die-Methode OnNext die-Methode jedes Beobachters auf.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 der Location Wert ist null, instanziiert die TrackLocation -Methode LocationUnknownException ein-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. Anschließend wird die-Methode jedes OnError Beobachters aufgerufen und an LocationUnknownException das-Objekt weitergeleitet.It then calls each observer's OnError method and passes it the LocationUnknownException object. Beachten Sie LocationUnknownException , dass Exceptionvon abgeleitet ist, aber keine neuen Elemente hinzufügt.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 den Empfang von TrackLocation Benachrichtigungen von einem- IObservable<T>.Subscribe Objekt durch Aufrufen der zugehörigen-Methode, die einem privaten generischen List<T> -Objekt einen Verweis auf das Observer-Objekt zuweist.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 zurück. hierbei IDisposable handelt es sich um eine-Implementierung, mit der Beobachter den Empfang von Benachrichtigungen beendenThe method returns an Unsubscriber object, which is an IDisposable implementation that enables observers to stop receiving notifications. Die LocationTracker -Klasse enthält auch EndTransmission eine-Methode.The LocationTracker class also includes an EndTransmission method. Wenn keine weiteren Standortdaten verfügbar sind, ruft die-Methode die- OnCompleted Methode jedes Beobachters auf 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 stellt die LocationReporter -Klasse die IObserver<T> -Implementierung bereit.In this example, the LocationReporter class provides the IObserver<T> implementation. Er zeigt Informationen zum aktuellen Speicherort der Konsole an.It displays information about the current location to the console. Der zugehörige Konstruktor name enthält einen-Parameter, LocationReporter der es der-Instanz ermöglicht, sich selbst in der Zeichen folgen Ausgabe zu identifizieren.Its constructor includes a name parameter, which enables the LocationReporter instance to identify itself in its string output. Sie enthält auch eine Subscribe -Methode, die einen-Rückruf für die- Subscribe Methode des Anbieters umschließt.It also includes a Subscribe method, which wraps a call to the provider's Subscribe method. Dadurch kann die-Methode den zurückgegebenen IDisposable Verweis einer privaten Variablen zuweisen.This allows the method to assign the returned IDisposable reference to a private variable. Die LocationReporter -Klasse enthält auch Unsubscribe eine-Methode, die IDisposable.Dispose die-Methode des-Objekts aufruft, das IObservable<T>.Subscribe von der-Methode zurückgegeben wird.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

Der folgende Code instanziiert dann den Anbieter und den 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> - IObservable<T> Schnittstelle und die-Schnittstelle stellen einen generalisierten Mechanismus für Pushbenachrichtigungen bereit, der auch als Beobachter-Entwurfsmuster bezeichnet wird.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, die Benachrichtigungen (den Anbieter IObserver<T> ) sendet. die-Schnittstelle stellt die Klasse dar, die Sie empfängt (der Beobachter).The IObservable<T> interface represents the class that sends notifications (the provider); the IObserver<T> interface represents the class that receives them (the observer). Tstellt die Klasse dar, die die Benachrichtigungs Informationen bereitstellt.T represents the class that provides the notification information. Bei einigen Push-basierten Benachrichtigungen kann die IObserver<T> Implementierung und T den gleichen Typ darstellen.In some push-based notifications, the IObserver<T> implementation and T can represent the same type.

Der Anbieter muss eine einzelne Methode implementieren, Subscribe, die angibt, dass ein Beobachter Pushbenachrichtigungen empfangen möchte.The provider must implement a single method, Subscribe, that indicates that an observer wants to receive push-based notifications. Aufrufer zur Methode übergeben eine Instanz des Observer.Callers to the method pass an instance of the observer. Die-Methode gibt IDisposable eine-Implementierung zurück, mit der Beobachter Benachrichtigungen jederzeit abbrechen können, bevor Sie von dem Anbieter nicht mehr gesendet werden.The method returns an IDisposable implementation that enables observers to cancel notifications at any time before the provider has stopped sending them.

Ein bestimmter Anbieter kann zu einem beliebigen Zeitpunkt über NULL, einen oder mehrere Beobachter verfügen.At any given time, a given provider may have zero, one, or multiple observers. Der Anbieter ist dafür verantwortlich, Verweise auf Beobachter zu speichern und sicherzustellen, dass Sie gültig sind, bevor Benachrichtigungen gesendet werden.The provider is responsible for storing references to observers and ensuring that they are valid before it sends notifications. Die IObservable<T> Schnittstelle nimmt keine Annahmen über die Anzahl von Beobachtern oder die Reihenfolge an, in der 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 durch Aufrufen IObserver<T> von Methoden an den Beobachter: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 die IObserver<T>.OnNext -Methode aufgerufen werden, um dem Beobachter ein T -Objekt zu übergeben, das über aktuelle Daten, geänderte Daten oder neue Daten verfügt.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.

  • Ein Fehlerzustand.An error condition. Der Anbieter kann die IObserver<T>.OnError -Methode aufzurufen, um den Beobachter zu benachrichtigen, dass 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 die IObserver<T>.OnCompleted -Methode zum Benachrichtigen des Beobachters auffordern, dass er das 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>)

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

Gilt für:

Siehe auch