akka.util

Switch

class Switch extends AnyRef

An atomic switch that can be either on or off

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Switch
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Switch(startAsOn: Boolean = false)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

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

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  8. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  11. 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

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

    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  14. 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.

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

  15. def ifOffYield[T](action: ⇒ T): Option[T]

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

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

  16. 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.

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

  17. def ifOnYield[T](action: ⇒ T): Option[T]

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

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

  18. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  19. def isOff: Boolean

    Returns whether the switch is IMMEDDIATELY off (no locking)

  20. def isOn: Boolean

    Returns whether the switch is IMMEDIATELY on (no locking)

  21. def locked[T](code: ⇒ T): T

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

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

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

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. def switchOff: Boolean

    Switches the switch off (if on), uses locking

  26. 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

  27. def switchOn: Boolean

    Switches the switch on (if off), uses locking

  28. 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

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

    Definition Classes
    AnyRef
  30. def toString(): String

    Definition Classes
    AnyRef → Any
  31. def transcend(from: Boolean, action: ⇒ Unit): Boolean

    Attributes
    protected
  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  33. final def wait(arg0: Long, arg1: Int): Unit

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  35. 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

  36. 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

  37. 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

  38. 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

Inherited from AnyRef

Inherited from Any

Ungrouped