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
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  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. def +(other: String): String

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

    Implicit information
    This member is added by an implicit conversion from Switch to ArrowAssoc[Switch] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

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

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (Switch) ⇒ Boolean, msg: ⇒ Any): Switch

    Implicit information
    This member is added by an implicit conversion from Switch to Ensuring[Switch] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (Switch) ⇒ Boolean): Switch

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

    Implicit information
    This member is added by an implicit conversion from Switch to Ensuring[Switch] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): Switch

    Implicit information
    This member is added by an implicit conversion from Switch to Ensuring[Switch] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

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

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

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

  18. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Switch to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

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

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

  22. 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)

  23. 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)

  24. 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)

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  26. def isOff: Boolean

    Returns whether the switch is IMMEDDIATELY off (no locking)

  27. def isOn: Boolean

    Returns whether the switch is IMMEDIATELY on (no locking)

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

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

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

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

    Definition Classes
    AnyRef
  32. def switchOff: Boolean

    Switches the switch off (if on), uses locking

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

  34. def switchOn: Boolean

    Switches the switch on (if off), uses locking

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

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

    Definition Classes
    AnyRef
  37. def toString(): String

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

    Attributes
    protected
  39. final def wait(): Unit

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

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

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

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

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

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

  46. def [B](y: B): (Switch, B)

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Switch to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (switch: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Switch to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (switch: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Switch

    Implicit information
    This member is added by an implicit conversion from Switch to ArrowAssoc[Switch] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (switch: ArrowAssoc[Switch]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Switch

    Implicit information
    This member is added by an implicit conversion from Switch to Ensuring[Switch] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (switch: Ensuring[Switch]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Switch to StringAdd

Inherited by implicit conversion any2stringfmt from Switch to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Switch to ArrowAssoc[Switch]

Inherited by implicit conversion any2Ensuring from Switch to Ensuring[Switch]

Ungrouped