Packages

t

com.twitter.util

CloseAwaitably

trait CloseAwaitably extends CloseAwaitably0[Unit]

A mixin to make an com.twitter.util.Awaitable out of a com.twitter.util.Closable.

Use closeAwaitably in the definition of close:

class MyClosable extends Closable with CloseAwaitably {
  def close(deadline: Time) = closeAwaitably {
    // close the resource
  }
}

Note: There is a Java-friendly API for this trait: com.twitter.util.AbstractCloseAwaitably.

Linear Supertypes
CloseAwaitably0[Unit], Awaitable[Unit], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CloseAwaitably
  2. CloseAwaitably0
  3. Awaitable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def closeAwaitably(f: ⇒ Future[Unit]): Future[Unit]

    closeAwaitably is intended to be used as a wrapper for close.

    closeAwaitably is intended to be used as a wrapper for close. The underlying f will be called at most once.

    Attributes
    protected
    Definition Classes
    CloseAwaitably0
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def isReady(implicit permit: CanAwait): Boolean

    Is this Awaitable ready? In other words: would calling Awaitable.ready block?

    Is this Awaitable ready? In other words: would calling Awaitable.ready block?

    Definition Classes
    CloseAwaitably0 → Awaitable
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def ready(timeout: Duration)(implicit permit: CanAwait): CloseAwaitably.this.type

    Support for Await.ready.

    Support for Await.ready. The use of the implicit permit is an access control mechanism: only Await.ready may call this method.

    Definition Classes
    CloseAwaitably0 → Awaitable
  18. def result(timeout: Duration)(implicit permit: CanAwait): Unit

    Support for Await.result.

    Support for Await.result. The use of the implicit permit is an access control mechanism: only Await.result may call this method.

    Definition Classes
    CloseAwaitably0 → Awaitable
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from CloseAwaitably0[Unit]

Inherited from Awaitable[Unit]

Inherited from AnyRef

Inherited from Any

Ungrouped