Class/Object

fs2.concurrent

SignallingRef

Related Docs: object SignallingRef | package concurrent

Permalink

abstract class SignallingRef[F[_], A] extends Ref[F, A] with Signal[F, A]

Pure holder of a single value of type A that can be both read and updated in the effect F.

Source
Signal.scala
Linear Supertypes
Signal[F, A], Ref[F, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SignallingRef
  2. Signal
  3. Ref
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SignallingRef()

    Permalink

Abstract Value Members

  1. abstract def access: F[(A, (A) ⇒ F[Boolean])]

    Permalink
    Definition Classes
    Ref
  2. abstract def continuous: Stream[F, A]

    Permalink

    Returns a stream of the current value of the signal.

    Returns a stream of the current value of the signal. An element is always available -- on each pull, the current value is supplied.

    Definition Classes
    Signal
  3. abstract def discrete: Stream[F, A]

    Permalink

    Returns a stream of the updates to this signal.

    Returns a stream of the updates to this signal.

    Updates that are very close together may result in only the last update appearing in the stream. If you want to be notified about every single update, use a Queue instead.

    Definition Classes
    Signal
  4. abstract def get: F[A]

    Permalink

    Asynchronously gets the current value of this Signal.

    Asynchronously gets the current value of this Signal.

    Definition Classes
    Signal
  5. abstract def getAndSet(a: A): F[A]

    Permalink
    Definition Classes
    Ref
  6. abstract def modify[B](f: (A) ⇒ (A, B)): F[B]

    Permalink
    Definition Classes
    Ref
  7. abstract def modifyState[B](state: State[A, B]): F[B]

    Permalink
    Definition Classes
    Ref
  8. abstract def set(a: A): F[Unit]

    Permalink
    Definition Classes
    Ref
  9. abstract def tryModify[B](f: (A) ⇒ (A, B)): F[Option[B]]

    Permalink
    Definition Classes
    Ref
  10. abstract def tryModifyState[B](state: State[A, B]): F[Option[B]]

    Permalink
    Definition Classes
    Ref
  11. abstract def tryUpdate(f: (A) ⇒ A): F[Boolean]

    Permalink
    Definition Classes
    Ref
  12. abstract def update(f: (A) ⇒ A): F[Unit]

    Permalink
    Definition Classes
    Ref

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SignallingRef[F, A] to any2stringadd[SignallingRef[F, A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SignallingRef[F, A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SignallingRef[F, A] to ArrowAssoc[SignallingRef[F, A]] performed by method ArrowAssoc in scala.Predef. This conversion will take place only if A is Boolean (A =:= Boolean).
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  8. def ensuring(cond: (SignallingRef[F, A]) ⇒ Boolean, msg: ⇒ Any): SignallingRef[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SignallingRef[F, A] to Ensuring[SignallingRef[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (SignallingRef[F, A]) ⇒ Boolean): SignallingRef[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SignallingRef[F, A] to Ensuring[SignallingRef[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): SignallingRef[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SignallingRef[F, A] to Ensuring[SignallingRef[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): SignallingRef[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from SignallingRef[F, A] to Ensuring[SignallingRef[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SignallingRef[F, A] to StringFormat[SignallingRef[F, A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. def mapK[G[_]](f: ~>[F, G])(implicit F: Functor[F]): Ref[G, A]

    Permalink
    Definition Classes
    Ref
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (SignallingRef[F, A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SignallingRef[F, A] to ArrowAssoc[SignallingRef[F, A]] performed by method ArrowAssoc in scala.Predef. This conversion will take place only if A is Boolean (A =:= Boolean).
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Signal[F, A]

Inherited from Ref[F, A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SignallingRef[F, A] to any2stringadd[SignallingRef[F, A]]

Inherited by implicit conversion StringFormat from SignallingRef[F, A] to StringFormat[SignallingRef[F, A]]

Inherited by implicit conversion Ensuring from SignallingRef[F, A] to Ensuring[SignallingRef[F, A]]

Inherited by implicit conversion ArrowAssoc from SignallingRef[F, A] to ArrowAssoc[SignallingRef[F, A]]

Ungrouped