c

akka.util

Switch

class Switch extends AnyRef

An atomic switch that can be either on or off

Source
LockUtil.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Switch
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Switch(startAsOn: Boolean = false)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Switch toany2stringadd[Switch] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Switch, B)
    Implicit
    This member is added by an implicit conversion from Switch toArrowAssoc[Switch] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (Switch) => Boolean, msg: => Any): Switch
    Implicit
    This member is added by an implicit conversion from Switch toEnsuring[Switch] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Switch) => Boolean): Switch
    Implicit
    This member is added by an implicit conversion from Switch toEnsuring[Switch] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Switch
    Implicit
    This member is added by an implicit conversion from Switch toEnsuring[Switch] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Switch
    Implicit
    This member is added by an implicit conversion from Switch toEnsuring[Switch] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def fold[T](on: => T)(off: => T): T

    Executes the provided callbacks depending on if the switch is either on or off waiting for any pending changes to happen before (locking) Be careful of longrunning or blocking within the provided action as it can lead to deadlocks or bad performance

  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. def ifOff(action: => Unit): Boolean

    Executes the provided action and returns if the action was executed or not, if the switch is IMMEDIATELY off (i.e.

    Executes the provided action and returns if the action was executed or not, if the switch is IMMEDIATELY off (i.e. no lock involved)

  18. def ifOffYield[T](action: => T): Option[T]

    Executes the provided action and returns its value if the switch is IMMEDIATELY off (i.e.

    Executes the provided action and returns its value if the switch is IMMEDIATELY off (i.e. no lock involved)

  19. def ifOn(action: => Unit): Boolean

    Executes the provided action and returns if the action was executed or not, if the switch is IMMEDIATELY on (i.e.

    Executes the provided action and returns if the action was executed or not, if the switch is IMMEDIATELY on (i.e. no lock involved)

  20. def ifOnYield[T](action: => T): Option[T]

    Executes the provided action and returns its value if the switch is IMMEDIATELY on (i.e.

    Executes the provided action and returns its value if the switch is IMMEDIATELY on (i.e. no lock involved)

  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. def isOff: Boolean

    Returns whether the switch is IMMEDIATELY off (no locking)

  23. def isOn: Boolean

    Returns whether the switch is IMMEDIATELY on (no locking)

  24. def locked[T](code: => T): T

    Executes the given code while holding this switch’s lock, i.e.

    Executes the given code while holding this switch’s lock, i.e. protected from concurrent modification of the switch status.

  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  28. def switchOff: Boolean

    Switches the switch off (if on), uses locking

  29. def switchOff(action: => Unit): Boolean

    Executes the provided action if the lock is on under a lock, so be _very_ careful with longrunning/blocking operations in it Only executes the action if the switch is on, and switches it off immediately after obtaining the lock Will switch it back on if the provided action throws an exception

  30. def switchOn: Boolean

    Switches the switch on (if off), uses locking

  31. def switchOn(action: => Unit): Boolean

    Executes the provided action if the lock is off under a lock, so be _very_ careful with longrunning/blocking operations in it Only executes the action if the switch is off, and switches it on immediately after obtaining the lock Will switch it back off if the provided action throws an exception

  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. def transcend(from: Boolean, action: => Unit): Boolean
    Attributes
    protected
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. def whileOff(action: => Unit): Boolean

    Executes the provided action and returns if the action was executed or not, if the switch is off, waiting for any pending changes to happen before (locking) Be careful of longrunning or blocking within the provided action as it can lead to deadlocks or bad performance

  39. def whileOffYield[T](action: => T): Option[T]

    Executes the provided action and returns its value if the switch is off, waiting for any pending changes to happen before (locking) Be careful of longrunning or blocking within the provided action as it can lead to deadlocks or bad performance

  40. def whileOn(action: => Unit): Boolean

    Executes the provided action and returns if the action was executed or not, if the switch is on, waiting for any pending changes to happen before (locking) Be careful of longrunning or blocking within the provided action as it can lead to deadlocks or bad performance

  41. def whileOnYield[T](action: => T): Option[T]

    Executes the provided action and returns its value if the switch is on, waiting for any pending changes to happen before (locking) Be careful of longrunning or blocking within the provided action as it can lead to deadlocks or bad performance

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Switch toStringFormat[Switch] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Switch, B)
    Implicit
    This member is added by an implicit conversion from Switch toArrowAssoc[Switch] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSwitch to any2stringadd[Switch]

Inherited by implicit conversion StringFormat fromSwitch to StringFormat[Switch]

Inherited by implicit conversion Ensuring fromSwitch to Ensuring[Switch]

Inherited by implicit conversion ArrowAssoc fromSwitch to ArrowAssoc[Switch]

Ungrouped