c

com.digitalasset.canton.lifecycle

PromiseUnlessShutdown

class PromiseUnlessShutdown[A] extends Promise[UnlessShutdown[A]] with RunOnShutdown

A wrapper for Promise that provides supervision of uncompleted promise's futures and aborting a promise due to shutdown

Linear Supertypes
RunOnShutdown, Promise[UnlessShutdown[A]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PromiseUnlessShutdown
  2. RunOnShutdown
  3. Promise
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new PromiseUnlessShutdown(description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit ecl: ErrorLoggingContext, ec: ExecutionContext)

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. def complete(result: Try[UnlessShutdown[A]]): PromiseUnlessShutdown.this.type
    Definition Classes
    Promise
  7. def completeWith(other: FutureUnlessShutdown[A]): PromiseUnlessShutdown.this.type
  8. def completeWith(other: Future[UnlessShutdown[A]]): PromiseUnlessShutdown.this.type
    Definition Classes
    Promise
  9. def done: Boolean

    true if the task has already run (maybe elsewhere)

    true if the task has already run (maybe elsewhere)

    Definition Classes
    PromiseUnlessShutdown → RunOnShutdown
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def failure(cause: Throwable): PromiseUnlessShutdown.this.type
    Definition Classes
    Promise
  13. def future: Future[UnlessShutdown[A]]
    Definition Classes
    PromiseUnlessShutdown → Promise
  14. def futureUS: FutureUnlessShutdown[A]
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  17. def isCompleted: Boolean
    Definition Classes
    PromiseUnlessShutdown → Promise
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def name: String

    the name, used for logging during shutdown

    the name, used for logging during shutdown

    Definition Classes
    PromiseUnlessShutdown → RunOnShutdown
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. def outcome(value: A): Unit

    Complete the promise with an outcome value.

    Complete the promise with an outcome value. If the promise has already been completed with an outcome, the new outcome will be ignored.

  24. def run(): Unit

    invoked by [FlagCloseable] during shutdown

    invoked by [FlagCloseable] during shutdown

    Definition Classes
    PromiseUnlessShutdown → RunOnShutdown
  25. def shutdown(): Unit

    Complete the promise with a shutdown

  26. def success(value: UnlessShutdown[A]): PromiseUnlessShutdown.this.type
    Definition Classes
    Promise
  27. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. def tryComplete(result: Try[UnlessShutdown[A]]): Boolean
    Definition Classes
    PromiseUnlessShutdown → Promise
  30. def tryFailure(cause: Throwable): Boolean
    Definition Classes
    Promise
  31. def trySuccess(value: UnlessShutdown[A]): Boolean
    Definition Classes
    Promise
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. 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
  2. final def tryCompleteWith(other: Future[UnlessShutdown[A]]): PromiseUnlessShutdown.this.type
    Definition Classes
    Promise
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Since this method is semantically equivalent to completeWith, use that instead.

Inherited from RunOnShutdown

Inherited from Promise[UnlessShutdown[A]]

Inherited from AnyRef

Inherited from Any

Ungrouped