Trait/Object

scalaz.stream.async.mutable

Signal

Related Docs: object Signal | package mutable

Permalink

trait Signal[A] extends immutable.Signal[A]

A signal whose value may be set asynchronously. Provides continuous and discrete streams for responding to changes to this value.

Source
Signal.scala
Linear Supertypes
immutable.Signal[A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Signal
  2. Signal
  3. AnyRef
  4. 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

Abstract Value Members

  1. abstract def changed: Process[Task, Boolean]

    Permalink

    Returns a continuous stream, indicating whether the value has changed.

    Returns a continuous stream, indicating whether the value has changed. This will spike true once for each time the value of Signal was changed. It will always start with true when the process is run or when the Signal is set for the first time.

    Definition Classes
    Signal

  2. abstract def changes: Process[Task, Unit]

    Permalink

    Returns the discrete version of changed.

    Returns the discrete version of changed. Will emit Unit when the value is changed.

    Definition Classes
    Signal

  3. abstract def compareAndSet(f: (Option[A]) ⇒ Option[A]): Task[Option[A]]

    Permalink

    Asynchronously sets the current value of this Signal and returns new value os this Signal.

    Asynchronously sets the current value of this Signal and returns new value os this Signal. If this Signal has not been set yet, the Task will return None and value is set. If this Signal is finished Task will fail with End exception. If this Signal is failed Task will fail with Signal failure exception.

    Furthermore if f results in evaluating to None, this Task is no-op and will return current value of the Signal.

  4. abstract def continuous: Process[Task, A]

    Permalink

    Returns the continuous version of this signal, always equal to the current A inside value.

    Returns the continuous version of this signal, always equal to the current A inside value. Note that this may not see all changes of A as it gets always current fresh A at every request.

    Definition Classes
    Signal

  5. abstract def discrete: Process[Task, A]

    Permalink

    Returns the discrete version of this signal, updated only when value is changed.

    Returns the discrete version of this signal, updated only when value is changed. Value may change several times between reads, but it is guaranteed this will always get latest known value after any change. If you want to be notified about every single change use async.queue for signalling.

    It will emit the current value of the Signal after being run or when the signal is set for the first time

    Definition Classes
    Signal

  6. abstract def get: Task[A]

    Permalink

    Asynchronously get the current value of this Signal

  7. abstract def getAndSet(a: A): Task[Option[A]]

    Permalink

    Asynchronously sets the current value of this Signal and returns previous value of the Signal.

    Asynchronously sets the current value of this Signal and returns previous value of the Signal. If this Signal has not been set yet, the Task will return None and value is set. If this Signal is finished Task will fail with End exception. If this Signal is failed Task will fail with Signal failure exception.

  8. abstract def set(a: A): Task[Unit]

    Permalink

    Sets the value of this Signal.

  9. abstract def sink: Sink[Task, Msg[A]]

    Permalink

    Returns sink that can be used to set this signal

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 Signal[A] to any2stringadd[Signal[A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Signal[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[A] to ArrowAssoc[Signal[A]] performed by method ArrowAssoc in scala.Predef.
    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
    @throws( ... )

  8. def close: Task[Unit]

    Permalink

    Indicate that the value is no longer valid.

    Indicate that the value is no longer valid. Any attempts to set or get this Signal after a close will fail with Terminated(End) exception. This Signal is finished from now on.

    Running this task once the Signal is failed or finished is no-op and this task will not fail.

  9. def ensuring(cond: (Signal[A]) ⇒ Boolean, msg: ⇒ Any): Signal[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[A] to Ensuring[Signal[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (Signal[A]) ⇒ Boolean): Signal[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[A] to Ensuring[Signal[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): Signal[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[A] to Ensuring[Signal[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): Signal[A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[A] to Ensuring[Signal[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def fail(error: Throwable): Task[Unit]

    Permalink

    Raise an asynchronous error for readers of this Signal.

    Raise an asynchronous error for readers of this Signal. Any attempts to set or get this Ref after the fail will result in task failing with Terminated(Error(errr)). This Signal is failed from now on.

    Running this task once the Signal is failed or finished is no-op and this task will not fail.

  16. def finalize(): Unit

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

  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[A] to StringFormat[Signal[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  21. def kill: Task[Unit]

    Permalink

    Indicate that the value is no longer valid.

    Indicate that the value is no longer valid. Any attempts to set or get this Signal after a close will fail with Terminated(Kill) exception. This Signal is finished from now on.

    Running this task once the Signal is failed or finished is no-op and this task will not fail.

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. def refresh: Task[Unit]

    Permalink

    Asynchronously refreshes the value of the signal, keep the value of this Signal the same, but notify any listeners.

    Asynchronously refreshes the value of the signal, keep the value of this Signal the same, but notify any listeners. If the Signal is not yet set, this is no-op

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  30. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. def →[B](y: B): (Signal[A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[A] to ArrowAssoc[Signal[A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from immutable.Signal[A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Signal[A] to any2stringadd[Signal[A]]

Inherited by implicit conversion StringFormat from Signal[A] to StringFormat[Signal[A]]

Inherited by implicit conversion Ensuring from Signal[A] to Ensuring[Signal[A]]

Inherited by implicit conversion ArrowAssoc from Signal[A] to ArrowAssoc[Signal[A]]

Ungrouped