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

定義

プッシュ ベースの通知を受信するメカニズムを定義します。Provides a mechanism for receiving push-based notifications.

generic <typename T>
public interface class IObserver
public interface IObserver<in T>
type IObserver<'T> = interface
Public Interface IObserver(Of In 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

クラスは、 LocationReporter 実装を提供し IObserver<T> ます。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 allows 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 enables 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 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

クラスは、 LocationTracker 実装を提供し IObservable<T> ます。The LocationTracker class provides the IObservable<T> implementation. この TrackLocation メソッドには、 Location 緯度と経度のデータを格納する null 許容のオブジェクトが渡されます。Its TrackLocation method is passed a nullable Location object that contains the latitude and longitude data. Location値がでない場合 nullTrackLocation メソッドは 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 LocationNotFoundException ます。これを次の例に示します。If the Location value is null, the TrackLocation method instantiates a LocationNotFoundException object, which is shown in the following example. 次に、各オブザーバーの OnError メソッドを呼び出し、オブジェクトを渡し LocationNotFoundException ます。It then calls each observer's OnError method and passes it the LocationNotFoundException object. LocationNotFoundException から派生 Exception しますが、新しいメンバーは追加されません。Note that LocationNotFoundException 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.

次のコードでは、プロバイダーとオブザーバーをインスタンス化します。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> IObservable<T> メソッドに対して自身のインスタンスを渡すことによって、プロバイダー (実装) からの通知を受け取るように配置さ IObservable<T>.Subscribe れます。An IObserver<T> implementation arranges to receive notifications from a provider (an IObservable<T> implementation) by passing an instance of itself to the provider's IObservable<T>.Subscribe method. このメソッドは、 IDisposable プロバイダーが通知の送信を終了する前にオブザーバーの登録を解除するために使用できるオブジェクトを返します。This method returns an IDisposable object that can be used to unsubscribe the observer before the provider finishes sending notifications.

インターフェイスは、 IObserver<T> オブザーバーが実装する必要がある次の3つのメソッドを定義します。The IObserver<T> interface defines the following three methods that the observer must implement:

  • メソッド。このメソッドは、 OnNext 通常、オブザーバーに新しいデータまたは状態情報を提供するためにプロバイダーによって呼び出されます。The OnNext method, which is typically called by the provider to supply the observer with new data or state information.

  • OnErrorメソッド。このメソッドは通常、データが使用できない、アクセスできない、または破損していることを示すためにプロバイダーによって呼び出されます。または、プロバイダーによって他のエラー状態が発生したことを示します。The OnError method, which is typically called by the provider to indicate that data is unavailable, inaccessible, or corrupted, or that the provider has experienced some other error condition.

  • OnCompletedメソッド。これは通常、オブザーバーに通知を送信する処理が完了したことを示すためにプロバイダーによって呼び出されます。The OnCompleted method, which is typically called by the provider to indicate that it has finished sending notifications to observers.

メソッド

OnCompleted()

プロバイダーでプッシュ ベースの通知の送信が完了したことをオブザーバーに通知します。Notifies the observer that the provider has finished sending push-based notifications.

OnError(Exception)

プロバイダーでエラー状態が発生したことをオブザーバーに通知します。Notifies the observer that the provider has experienced an error condition.

OnNext(T)

新しいデータをオブザーバーに提供します。Provides the observer with new data.

適用対象

こちらもご覧ください