1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
|
// Copyright (c) Microsoft Open Technologies, Inc. All rights reserved. See License.txt in the project root for license information.
using System.Reactive.Disposables;
namespace System.Reactive.Subjects
{
/// <summary>
/// Represents a value that changes over time.
/// Observers can subscribe to the subject to receive the last (or initial) value and all subsequent notifications.
/// </summary>
/// <typeparam name="T">The type of the elements processed by the subject.</typeparam>
public sealed class BehaviorSubject<T> : ISubject<T>, IDisposable
{
/// <summary>
/// Gets the current value or throws an exception.
/// </summary>
/// <value>The initial value passed to the constructor until <see cref="OnNext"/> is called; after which, the last value passed to <see cref="OnNext"/>.</value>
/// <remarks>
/// <para><see cref="Value"/> is frozen after <see cref="OnCompleted"/> is called.</para>
/// <para>After <see cref="OnError"/> is called, <see cref="Value"/> always throws the specified exception.</para>
/// <para>An exception is always thrown after <see cref="Dispose"/> is called.</para>
/// <alert type="caller">
/// Reading <see cref="Value"/> is a thread-safe operation, though there's a potential race condition when <see cref="OnNext"/> or <see cref="OnError"/> are being invoked concurrently.
/// In some cases, it may be necessary for a caller to use external synchronization to avoid race conditions.
/// </alert>
/// </remarks>
/// <exception cref="ObjectDisposedException">Dispose was called.</exception>
public T Value
{
get
{
lock (_gate)
{
CheckDisposed();
if (_exception != null)
{
throw _exception;
}
return _value;
}
}
}
private readonly object _gate = new object();
private ImmutableList<IObserver<T>> _observers;
private bool _isStopped;
private T _value;
private Exception _exception;
private bool _isDisposed;
/// <summary>
/// Initializes a new instance of the <see cref="System.Reactive.Subjects.BehaviorSubject<T>"/> class which creates a subject that caches its last value and starts with the specified value.
/// </summary>
/// <param name="value">Initial value sent to observers when no other value has been received by the subject yet.</param>
public BehaviorSubject(T value)
{
_value = value;
_observers = new ImmutableList<IObserver<T>>();
}
/// <summary>
/// Indicates whether the subject has observers subscribed to it.
/// </summary>
public bool HasObservers
{
get
{
var observers = _observers;
return observers != null && observers.Data.Length > 0;
}
}
/// <summary>
/// Notifies all subscribed observers about the end of the sequence.
/// </summary>
public void OnCompleted()
{
var os = default(IObserver<T>[]);
lock (_gate)
{
CheckDisposed();
if (!_isStopped)
{
os = _observers.Data;
_observers = new ImmutableList<IObserver<T>>();
_isStopped = true;
}
}
if (os != null)
{
foreach (var o in os)
o.OnCompleted();
}
}
/// <summary>
/// Notifies all subscribed observers about the exception.
/// </summary>
/// <param name="error">The exception to send to all observers.</param>
/// <exception cref="ArgumentNullException"><paramref name="error"/> is null.</exception>
public void OnError(Exception error)
{
if (error == null)
throw new ArgumentNullException("error");
var os = default(IObserver<T>[]);
lock (_gate)
{
CheckDisposed();
if (!_isStopped)
{
os = _observers.Data;
_observers = new ImmutableList<IObserver<T>>();
_isStopped = true;
_exception = error;
}
}
if (os != null)
foreach (var o in os)
o.OnError(error);
}
/// <summary>
/// Notifies all subscribed observers about the arrival of the specified element in the sequence.
/// </summary>
/// <param name="value">The value to send to all observers.</param>
public void OnNext(T value)
{
var os = default(IObserver<T>[]);
lock (_gate)
{
CheckDisposed();
if (!_isStopped)
{
_value = value;
os = _observers.Data;
}
}
if (os != null)
{
foreach (var o in os)
o.OnNext(value);
}
}
/// <summary>
/// Subscribes an observer to the subject.
/// </summary>
/// <param name="observer">Observer to subscribe to the subject.</param>
/// <returns>Disposable object that can be used to unsubscribe the observer from the subject.</returns>
/// <exception cref="ArgumentNullException"><paramref name="observer"/> is null.</exception>
public IDisposable Subscribe(IObserver<T> observer)
{
if (observer == null)
throw new ArgumentNullException("observer");
var ex = default(Exception);
lock (_gate)
{
CheckDisposed();
if (!_isStopped)
{
_observers = _observers.Add(observer);
observer.OnNext(_value);
return new Subscription(this, observer);
}
ex = _exception;
}
if (ex != null)
observer.OnError(ex);
else
observer.OnCompleted();
return Disposable.Empty;
}
class Subscription : IDisposable
{
private readonly BehaviorSubject<T> _subject;
private IObserver<T> _observer;
public Subscription(BehaviorSubject<T> subject, IObserver<T> observer)
{
_subject = subject;
_observer = observer;
}
public void Dispose()
{
if (_observer != null)
{
lock (_subject._gate)
{
if (!_subject._isDisposed && _observer != null)
{
_subject._observers = _subject._observers.Remove(_observer);
_observer = null;
}
}
}
}
}
void CheckDisposed()
{
if (_isDisposed)
throw new ObjectDisposedException(string.Empty);
}
/// <summary>
/// Unsubscribe all observers and release resources.
/// </summary>
public void Dispose()
{
lock (_gate)
{
_isDisposed = true;
_observers = null;
_value = default(T);
_exception = null;
}
}
}
}
|