trait BaseObservable[+Self[+_] <: Observable[_], +A] extends Source[A] with Named
This trait represents a reactive value that can be subscribed to.
It has only one direct subtype, Observable, which in turn has two direct subtypes, EventStream and Signal.
BaseObservable is the same as Observable, it just lives in a separate trait for technical reasons (the Self type param).
All Observables are lazy. An Observable starts when it gets its first observer (internal or external), and stops when it loses its last observer (again, internal or external).
Basic idea: Lazy Observable only holds references to those children that have any observers (either directly on themselves, or on any of their descendants). What this achieves: - Stream only propagates its value to children that (directly or not) have observers - Stream calculates its value only once regardless of how many observers / children it has) (so, all streams are "hot" observables) - Stream doesn't hold references to Streams that no one observes, allowing those Streams to be garbage collected if they are otherwise unreachable (which they should become when their subscriptions are killed by their owners)
- Alphabetic
- By Inheritance
- BaseObservable
- Named
- Source
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def addExternalObserver(observer: Observer[A], owner: Owner): Subscription
- Attributes
- protected[this]
- abstract def addInternalObserver(observer: InternalObserver[A]): Unit
Child observable should call this method on its parents when it is started.
- abstract def addObserver(observer: Observer[A])(implicit owner: Owner): Subscription
Subscribe an external observer to this observable
- abstract def debugWith(debugger: Debugger[A]): Self[A]
Create a new observable that listens to this one and has a debugger attached.
Create a new observable that listens to this one and has a debugger attached.
Use the resulting observable in place of the original observable in your code. See docs for details.
There are more convenient methods available implicitly from DebuggableObservable and DebuggableSignal, such as debugLog(), debugSpyEvents(), etc.
- abstract def map[B](project: (A) => B): Self[B]
- project
Note: guarded against exceptions
- abstract def numAllObservers: Int
Total number of internal and external observers
Total number of internal and external observers
- Attributes
- protected
- abstract def recover[B >: A](pf: PartialFunction[Throwable, Option[B]]): Self[B]
- pf
Note: guarded against exceptions
- abstract def recoverToTry: Self[Try[A]]
Convert this to an observable that emits Failure(err) instead of erroring
- abstract def removeExternalObserverNow(observer: Observer[A]): Unit
- Attributes
- protected[airstream]
- abstract def removeInternalObserverNow(observer: InternalObserver[A]): Unit
Child observable should call Transaction.removeInternalObserver(parent, childInternalObserver) when it is stopped.
- abstract def toObservable: Observable[A]
- Definition Classes
- Source
- abstract val topoRank: Int
Note: Use Protected.topoRank(observable) to read another observable's topoRank if needed
Note: Use Protected.topoRank(observable) to read another observable's topoRank if needed
- Attributes
- protected
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- def defaultDisplayName: String
This is the method that subclasses override to preserve the user's ability to set custom display names.
This is the method that subclasses override to preserve the user's ability to set custom display names.
- Attributes
- protected
- Definition Classes
- Named
- final def displayName: String
- Definition Classes
- Named
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def flatMap[B, Inner[_], Output[+_] <: Observable[_]](compose: (A) => Inner[B])(implicit strategy: FlattenStrategy[Self, Inner, Output]): Output[B]
- compose
Note: guarded against exceptions
- Annotations
- @inline()
- def foreach(onNext: (A) => Unit)(implicit owner: Owner): Subscription
Create an external observer from a function and subscribe it to this observable.
Create an external observer from a function and subscribe it to this observable.
Note: since you won't have a reference to the observer, you will need to call Subscription.kill() to unsubscribe
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isStarted: Boolean
- Attributes
- protected
- def mapTo[B](value: => B): Self[B]
value
is passed by name, so it will be evaluated whenever the Observable fires.value
is passed by name, so it will be evaluated whenever the Observable fires. Use it to sample mutable values (e.g. myInput.ref.value in Laminar).See also: mapToStrict
- value
Note: guarded against exceptions
- def mapToStrict[B](value: B): Self[B]
value
is evaluated strictly, only once, when this method is called.value
is evaluated strictly, only once, when this method is called.See also: mapTo
- val maybeDisplayName: UndefOr[String]
This name should identify the instance (observable or observer) uniquely enough for your purposes.
This name should identify the instance (observable or observer) uniquely enough for your purposes. You can read / write it to simplify debugging. Airstream uses this in
debugLog*
methods. In the future, we will expand on this. #TODO[Debug] We don't use this to its full potential yet.- Attributes
- protected[this]
- Definition Classes
- Named
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def onAddedExternalObserver(observer: Observer[A]): Unit
- Attributes
- protected[this]
- def onStart(): Unit
This method is fired when this observable starts working (listening for parent events and/or firing its own events), that is, when it gets its first Observer (internal or external).
This method is fired when this observable starts working (listening for parent events and/or firing its own events), that is, when it gets its first Observer (internal or external).
onStart can potentially be called multiple times, the second time being after it has stopped (see onStop).
- Attributes
- protected
- def onStop(): Unit
This method is fired when this observable stops working (listening for parent events and/or firing its own events), that is, when it loses its last Observer (internal or external).
This method is fired when this observable stops working (listening for parent events and/or firing its own events), that is, when it loses its last Observer (internal or external).
onStop can potentially be called multiple times, the second time being after it has started again (see onStart).
- Attributes
- protected
- implicit def protectedAccessEvidence: Protected
- Attributes
- protected
- Annotations
- @inline()
- def recoverIgnoreErrors: Self[A]
- def setDisplayName(name: String): BaseObservable.this.type
Set the display name for this instance (observable or observer).
Set the display name for this instance (observable or observer). - This method modifies the instance and returns
this
. It does not create a new instance. - New name you set will override the previous name, if any. This might change in the future. For the sake of sanity, don't call this more than once for the same instance. - If display name is set, toString will output it instead of the standard type@hashcode string- Definition Classes
- Named
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toSignalIfStream[B >: A](ifStream: (EventStream[A]) => Signal[B]): Signal[B]
- def toStreamIfSignal[B >: A](ifSignal: (Signal[A]) => EventStream[B]): EventStream[B]
- final def toString(): String
Override defaultDisplayName instead of this, if you need to.
Override defaultDisplayName instead of this, if you need to.
- Definition Classes
- Named → AnyRef → Any
- def toWeakSignal: Signal[Option[A]]
Convert this observable to a signal of Option[A].
Convert this observable to a signal of Option[A]. If it is a stream, set initial value to None.
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated