IObservable<T> インターフェイス

定義

プッシュ ベースの通知用プロバイダーを定義します。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)

型パラメーター

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 メソッドには、緯度と経度のデータを格納する null 許容の 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. LocationUnknownExceptionExceptionから派生しますが、新しいメンバーは追加されません。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

オブザーバーは、IObservable<T>.Subscribe メソッドを呼び出すことによって TrackLocation オブジェクトから通知を受信するように登録します。これにより、オブザーバーオブジェクトへの参照がプライベートの汎用 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 クラスには、IObservable<T>.Subscribe メソッドによって返されるオブジェクトの IDisposable.Dispose メソッドを呼び出す Unsubscribe メソッドも含まれています。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> インターフェイスは、オブザーバーデザインパターンとも呼ばれる、プッシュベースの通知の一般化されたメカニズムを提供します。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. 一部のプッシュベースの通知では、IObserver<T> の実装と T は同じ型を表すことができます。In some push-based notifications, the IObserver<T> implementation and T can represent the same type.

プロバイダーは、オブザーバーがプッシュベースの通知を受け取ることを示す1つのメソッド Subscribeを実装する必要があります。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.

特定の時点で、指定されたプロバイダーは、0、1、または複数のオブザーバーを持つことができます。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> メソッドを呼び出すことによって、次の3種類の通知をオブザーバーに送信します。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.

適用対象

こちらもご覧ください