Packages

final case class Handle(completed: Future[Unit], killSwitch: KillSwitch) extends Product with Serializable

A handle of a running program

completed

will complete right after the program completed

  • if no KillSwitch used,
    • it will complete successfully as program successfully ends
    • it will complete with the same failure that failed the program
  • if KillSwitch aborted, this completes with the same Throwable
  • if KillSwitch shut down, this completes successfully After signalling completion, the program finished it's execution and has released all resources it acquired.
killSwitch

to signal abortion and shutdown

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Handle
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Handle(completed: Future[Unit], killSwitch: KillSwitch)

    completed

    will complete right after the program completed

    • if no KillSwitch used,
      • it will complete successfully as program successfully ends
      • it will complete with the same failure that failed the program
    • if KillSwitch aborted, this completes with the same Throwable
    • if KillSwitch shut down, this completes successfully After signalling completion, the program finished it's execution and has released all resources it acquired.
    killSwitch

    to signal abortion and shutdown

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. val completed: Future[Unit]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. val killSwitch: KillSwitch
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped