Class BehaviorSubject<T>

Namespace

RxSharp.Subjects

Assembly

RxSharp.dll

A Subject<T> that requires an initial value and synchronously replays its current value to every new subscriber. Mirrors rxjs's BehaviorSubject.

public class BehaviorSubject<T> : Subject<T>, IObserver<T>, IDisposable

Type Parameters

T

The type of values pushed through the subject.

Inheritance

System.Object

Subject<T>

BehaviorSubject<T>

Implements

IObserver<T>

IDisposable

Inherited Members

Subject<T>.IsDisposed

Subject<T>.IsStopped

Subject<T>.HasError

Subject<T>.ThrownError

Subject<T>.OnError(Exception)

Subject<T>.OnCompleted()

Subject<T>.Subscribe(Action<T>?, Action<Exception>?, Action?)

Subject<T>.AsObservable()

Subject<T>.Dispose()

Subject<T>.RemoveObserver(IObserver<T>)

Constructors

BehaviorSubject(T)

Initializes a new instance of the BehaviorSubject<T> class with the given current value.

public BehaviorSubject(T value)

Parameters

value T

The initial current value, returned by Value and replayed to the first subscriber(s) until the next OnNext(T).

Properties

Value

The current value. Throws the subject's stored error if it has errored, or ObjectDisposedException if the subject has been disposed. A subject that merely completed (without erroring) still returns its last value -- matches rxjs's getValue()/value semantics, where only hasError or "closed" (unsubscribed) throw.

public T Value { get; }

Property Value

T

Methods

OnNext(T)

Pushes a new current value and forwards it to every observer currently subscribed. A no-op forward once the subject has stopped or been disposed (see OnNext(T)).

public override void OnNext(T value)

Parameters

value T

The new current value.

Subscribe(IObserver<T>)

Subscribes observer and, unless the subject had already terminated, immediately replays the current value to it.

public override IDisposable Subscribe(IObserver<T> observer)

Parameters

observer IObserver<T>

The observer to subscribe.

Returns

IDisposable

A disposable that unsubscribes observer, per Subscribe(IObserver<T>).