com.twitter.concurrent

AsyncSemaphore

class AsyncSemaphore extends AnyRef

An AsyncSemaphore is a traditional semaphore but with asynchronous execution. Grabbing a permit returns a Future[Permit]

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AsyncSemaphore
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AsyncSemaphore(initialPermits: Int, maxWaiters: Int)

  2. new AsyncSemaphore(initialPermits: Int = 0)

  3. new AsyncSemaphore(initialPermits: Int, maxWaiters: Option[Int])

    Attributes
    protected

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. def acquire(): Future[Permit]

    Acquire a Permit, asynchronously.

    Acquire a Permit, asynchronously. Be sure to permit.release() in a 'finally' block of your onSuccess() callback.

    Interrupting this future is only advisory, and will not release the permit if the future has already been satisfied.

    returns

    a Future[Permit] when the Future is satisfied, computation can proceed, or a Future.Exception[RejectedExecutionException] if the configured maximum number of waitq would be exceeded.

  5. def acquireAndRun[T](func: ⇒ Future[T]): Future[T]

    Execute the function asynchronously when a permit becomes available.

    Execute the function asynchronously when a permit becomes available.

    If the function throws a non-fatal exception, the exception is returned as part of the Future. For all exceptions, the permit would be released before returning.

    returns

    a Future[T] equivalent to the return value of the input function. If the configured maximum value of waitq is reached, Future.Exception[RejectedExecutionException] is returned.

  6. def acquireAndRunSync[T](func: ⇒ T): Future[T]

    Execute the function when a permit becomes available.

    Execute the function when a permit becomes available.

    If the function throws an exception, the exception is returned as part of the Future. For all exceptions, the permit would be released before returning.

    returns

    a Future[T] equivalent to the return value of the input function. If the configured maximum value of waitq is reached, Future.Exception[RejectedExecutionException] is returned.

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  18. def numPermitsAvailable: Int

  19. def numWaiters: Int

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

    Definition Classes
    AnyRef
  21. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped