IObservable<T> Interface

Определение

Определяет поставщика push-уведомлений. Defines a provider for push-based notification.

public interface IObservable<out T>
Параметры типа
T

Объект, предоставляющий сведения об уведомлениях. The object that provides notification information.

Производный

Примеры

В следующем примере шаблон разработки наблюдателя.The following example illustrates the observer design pattern. Он определяет Location класс, содержащий сведения широты и долготы.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

LocationTracker Класс предоставляет IObservable<T> реализации.The LocationTracker class provides the IObservable<T> implementation. Его TrackLocation методу передается значение необязательной определенности Location объект, содержащий данные широты и долготы.Its TrackLocation method is passed a nullable Location object that contains the latitude and longitude data. Если Location значение не null, TrackLocation вызовы методов OnNext метод каждого наблюдателя.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

Если Location значение null, TrackLocation метод создает экземпляр LocationUnknownException объект, который показан в следующем примере.If the Location value is null, the TrackLocation method instantiates a LocationUnknownException object, which is shown in the following example. Затем он вызывает каждого наблюдателя OnError метод и передает его LocationUnknownException объекта.It then calls each observer's OnError method and passes it the LocationUnknownException object. Обратите внимание, что LocationUnknownException является производным от Exception, но не добавляет новые члены.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

Наблюдатели регистрируются для получения уведомлений из TrackLocation , вызвав его IObservable<T>.Subscribe метод, который назначает ссылку на объект наблюдателя закрытый универсальный List<T> объекта.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. Этот метод возвращает Unsubscriber объект, являющийся IDisposable реализацию, позволяющую наблюдателям прекратить получение уведомлений.The method returns an Unsubscriber object, which is an IDisposable implementation that enables observers to stop receiving notifications. LocationTracker Класс также включает EndTransmission метод.The LocationTracker class also includes an EndTransmission method. При дальнейшей данные расположения недоступны, этот метод вызывает каждого наблюдателя OnCompleted метода и затем очищает внутренний список наблюдателей.When no further location data is available, the method calls each observer's OnCompleted method and then clears the internal list of observers.

В этом примере LocationReporter класс предоставляет IObserver<T> реализации.In this example, the LocationReporter class provides the IObserver<T> implementation. В нем отображаются данные о текущем расположении в консоль.It displays information about the current location to the console. Включает в себя его конструктор name параметр, позволяющий LocationReporter экземпляра для собственной идентификации в выводимой строке.Its constructor includes a name parameter, which enables the LocationReporter instance to identify itself in its string output. Он также включает Subscribe метод, который создает оболочку для вызова поставщика Subscribe метод.It also includes a Subscribe method, which wraps a call to the provider's Subscribe method. Это позволяет методу, назначить возвращаемый IDisposable ссылку на частную переменную.This allows the method to assign the returned IDisposable reference to a private variable. LocationReporter Класс также включает Unsubscribe метод, который вызывает IDisposable.Dispose метод объекта, который возвращается методом 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. В следующем коде определяется 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

Следующий код создает экземпляр поставщика и наблюдателя.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.

Комментарии

IObserver<T> И IObservable<T> интерфейсы предоставляют универсальный механизм для Push-уведомлений, также известный как шаблон разработки наблюдателя.The IObserver<T> and IObservable<T> interfaces provide a generalized mechanism for push-based notification, also known as the observer design pattern. IObservable<T> Интерфейс представляет класс, который отправляет уведомления (поставщик); IObserver<T> интерфейс представляет класс, который получает их (наблюдатель).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 Представляет класс, который предоставляет сведения об уведомлении.T represents the class that provides the notification information. В некоторых Push-уведомлений IObserver<T> реализации и T можно принадлежат к одному типу.In some push-based notifications, the IObserver<T> implementation and T can represent the same type.

Поставщик должен реализовывать единственный метод, Subscribe, которое указывает, что наблюдатель может принимать Push-уведомлений.The provider must implement a single method, Subscribe, that indicates that an observer wants to receive push-based notifications. Вызывающие объекты метода передать экземпляр наблюдателя.Callers to the method pass an instance of the observer. Этот метод возвращает IDisposable реализацию, позволяющую наблюдателям отменить в любое время, прежде чем поставщик прекратил их отправкой уведомления.The method returns an IDisposable implementation that enables observers to cancel notifications at any time before the provider has stopped sending them.

В любой момент времени заданный поставщик может иметь ноль, один или нескольких наблюдателей.At any given time, a given provider may have zero, one, or multiple observers. Поставщик отвечает за сохранение ссылок на наблюдатели и гарантируя, что они являются допустимыми, перед отправкой уведомления.The provider is responsible for storing references to observers and ensuring that they are valid before it sends notifications. IObservable<T> Интерфейс не делать никаких предположений о количестве наблюдателей или порядок, в котором будут отправлены.The IObservable<T> interface does not make any assumptions about the number of observers or the order in which notifications are sent.

Поставщик отправляет следующие три типа уведомлений наблюдателю путем вызова IObserver<T> методы:The provider sends the following three kinds of notifications to the observer by calling IObserver<T> methods:

  • Текущие данные.The current data. Поставщик может выполнить вызов IObserver<T>.OnNext метод для передачи наблюдатель T объект, имеющий текущие данные, измененные данные или новые данные.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.

  • Условие ошибки.An error condition. Поставщик может выполнить вызов IObserver<T>.OnError метод для уведомления наблюдателя о возникновении некоторой ошибки.The provider can call the IObserver<T>.OnError method to notify the observer that some error condition has occurred.

  • Дополнительные данные отсутствуют.No further data. Поставщик может выполнить вызов IObserver<T>.OnCompleted метод для уведомления наблюдателя о завершении отправки уведомлений.The provider can call the IObserver<T>.OnCompleted method to notify the observer that it has finished sending notifications.

Методы

Subscribe(IObserver<T>)

Уведомляет поставщика о том, что наблюдатель должен получать уведомления. Notifies the provider that an observer is to receive notifications.

Применяется к

См. также