CloseAwaitably

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

Known Subclasses

InputStreamReader

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

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

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
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
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package util

trait CloseAwaitably extends CloseAwaitably0[Unit]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def closeAwaitably(f: ⇒ Future[Unit]): Future[Unit]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isReady(implicit permit: CanAwait): Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def ready(timeout: Duration)(implicit permit: CanAwait): CloseAwaitably.this.type

def result(timeout: Duration)(implicit permit: CanAwait): Unit

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from CloseAwaitably0[Unit]

Inherited from Awaitable[Unit]

Inherited from AnyRef

Inherited from Any

Ungrouped