IObservable<T> Interfejs

Definicja

Definiuje dostawcę powiadomień wypychanych.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)

Parametry typu

T

Obiekt, który zawiera informacje o powiadomieniach.The object that provides notification information.

Pochodne

Przykłady

Poniższy przykład ilustruje Wzorzec projektowy obserwatora.The following example illustrates the observer design pattern. Definiuje klasę Location, która zawiera informacje o długości i szerokości geograficznej.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

Klasa LocationTracker zapewnia implementację IObservable<T>.The LocationTracker class provides the IObservable<T> implementation. Metoda TrackLocation jest przenoszona do obiektu Location nullable, który zawiera dane geograficzne i długości geograficznej.Its TrackLocation method is passed a nullable Location object that contains the latitude and longitude data. Jeśli wartość Location nie jest null, Metoda TrackLocation wywoła metodę OnNext każdego obserwatora.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

Jeśli wartość Location jest null, Metoda TrackLocation tworzy wystąpienie obiektu LocationUnknownException, który jest przedstawiony w poniższym przykładzie.If the Location value is null, the TrackLocation method instantiates a LocationUnknownException object, which is shown in the following example. Następnie wywołuje OnError metodę każdego obserwatora i przekazuje ją do LocationUnknownException obiektu.It then calls each observer's OnError method and passes it the LocationUnknownException object. Należy zauważyć, że LocationUnknownException pochodzą z Exception, ale nie dodaje żadnych nowych członków.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

Obserwatorzy rejestrują się w celu otrzymywania powiadomień z obiektu TrackLocation, wywołując metodę IObservable<T>.Subscribe, która przypisuje odwołanie do obiektu obserwatora do prywatnego obiektu List<T> ogólnego.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. Metoda zwraca obiekt Unsubscriber, który jest implementacją IDisposable, która umożliwia obserwatorom zaprzestanie otrzymywania powiadomień.The method returns an Unsubscriber object, which is an IDisposable implementation that enables observers to stop receiving notifications. Klasa LocationTracker zawiera również metodę EndTransmission.The LocationTracker class also includes an EndTransmission method. Gdy żadne dalsze dane lokalizacji nie są dostępne, metoda wywołuje każdą metodę OnCompleted obserwatora, a następnie czyści wewnętrzną listę obserwatorów.When no further location data is available, the method calls each observer's OnCompleted method and then clears the internal list of observers.

W tym przykładzie Klasa LocationReporter zapewnia implementację IObserver<T>.In this example, the LocationReporter class provides the IObserver<T> implementation. Informacje o bieżącej lokalizacji są wyświetlane w konsoli programu.It displays information about the current location to the console. Jego Konstruktor zawiera parametr name, który umożliwia wystąpienie LocationReporter, aby identyfikować je w danych wyjściowych ciągu.Its constructor includes a name parameter, which enables the LocationReporter instance to identify itself in its string output. Zawiera również metodę Subscribe, która zawija wywołanie do metody Subscribe dostawcy.It also includes a Subscribe method, which wraps a call to the provider's Subscribe method. Umożliwia to metodu przypisanie zwróconego odwołania IDisposable do zmiennej prywatnej.This allows the method to assign the returned IDisposable reference to a private variable. Klasa LocationReporter zawiera również metodę Unsubscribe, która wywołuje metodę IDisposable.Dispose obiektu, który jest zwracany przez metodę IObservable<T>.Subscribe.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. Poniższy kod definiuje klasę LocationReporter.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

Poniższy kod tworzy wystąpienie dostawcy i obserwatora.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.

Uwagi

Interfejsy IObserver<T> i IObservable<T> zapewniają uogólniony mechanizm powiadomień opartych na wypychaniu, znany również jako Wzorzec projektowy obserwatora.The IObserver<T> and IObservable<T> interfaces provide a generalized mechanism for push-based notification, also known as the observer design pattern. Interfejs IObservable<T> reprezentuje klasę, która wysyła powiadomienia (dostawca); Interfejs IObserver<T> reprezentuje klasę, która otrzymuje je (obserwator).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 reprezentuje klasę, która zawiera informacje o powiadomieniach.T represents the class that provides the notification information. W niektórych powiadomieniach wypychanych implementacja IObserver<T> i T mogą reprezentować ten sam typ.In some push-based notifications, the IObserver<T> implementation and T can represent the same type.

Dostawca musi zaimplementować jedną metodę Subscribe, która wskazuje, że obserwator chce otrzymywać powiadomienia oparte na wypychaniu.The provider must implement a single method, Subscribe, that indicates that an observer wants to receive push-based notifications. Wywołujący do metody przekażą wystąpienie obserwatora.Callers to the method pass an instance of the observer. Metoda zwraca implementację IDisposable, która umożliwia obserwatorom anulowanie powiadomień w dowolnym momencie przed zatrzymaniem wysyłania przez dostawcę.The method returns an IDisposable implementation that enables observers to cancel notifications at any time before the provider has stopped sending them.

W danym momencie dany dostawca może mieć zero, jeden lub wiele obserwatorów.At any given time, a given provider may have zero, one, or multiple observers. Dostawca jest odpowiedzialny za przechowywanie odwołań do obserwatorów i upewnienie się, że są one ważne przed wysłaniem powiadomień.The provider is responsible for storing references to observers and ensuring that they are valid before it sends notifications. Interfejs IObservable<T> nie przyjmuje żadnych założeń dotyczących liczby obserwatorów ani kolejności, w której wysyłane są powiadomienia.The IObservable<T> interface does not make any assumptions about the number of observers or the order in which notifications are sent.

Dostawca wysyła następujące trzy rodzaje powiadomień do obserwatora, wywołując metody IObserver<T>:The provider sends the following three kinds of notifications to the observer by calling IObserver<T> methods:

  • Bieżące dane.The current data. Dostawca może wywoływać metodę IObserver<T>.OnNext, aby przekazać obserwatorowi T obiekt, który ma bieżące dane, zmienione dane lub dane świeże.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.

  • Warunek błędu.An error condition. Dostawca może wywołać metodę IObserver<T>.OnError, aby powiadomić obserwatora o wystąpieniu błędu.The provider can call the IObserver<T>.OnError method to notify the observer that some error condition has occurred.

  • Brak dalszych danych.No further data. Dostawca może wywoływać metodę IObserver<T>.OnCompleted, aby powiadomić obserwatora, że zakończył wysyłanie powiadomień.The provider can call the IObserver<T>.OnCompleted method to notify the observer that it has finished sending notifications.

Metody

Subscribe(IObserver<T>)

Powiadamia dostawcę o tym, że obserwator otrzymuje powiadomienia.Notifies the provider that an observer is to receive notifications.

Dotyczy

Zobacz też