TaskSemaphore

The TaskSemaphore is an asynchronous semaphore implementation that limits the parallelism on task execution.

The following example instantiates a semaphore with a maximum parallelism of 10:

val semaphore = TaskSemaphore(maxParallelism = 10)

def makeRequest(r: HttpRequest): Task[HttpResponse] = ???

// For such a task no more than 10 requests
// are allowed to be executed in parallel.
val task = semaphore.greenLight(makeRequest(???))

Linear Supertypes

Serializable, Serializable, AnyRef, Any

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
val acquire: Task[Unit]

Triggers a permit acquisition, returning a task that upon evaluation will only complete after a permit has been acquired.
def activeCount: Coeval[Int]

Returns the number of active tasks that are holding on to the available permits.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val awaitAllReleased: Task[Unit]

Returns a task, that upon evaluation will be complete when all the currently acquired permits are released, or in other words when the activeCount is zero.
Returns a task, that upon evaluation will be complete when all the currently acquired permits are released, or in other words when the activeCount is zero.
This also means that we are going to wait for the acquisition and release of all enqueued promises as well.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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 greenLight[A](fa: Task[A]): Task[A]

Creates a new task ensuring that the given source acquires an available permit from the semaphore before it is being executed.
Creates a new task ensuring that the given source acquires an available permit from the semaphore before it is being executed.
The returned task also takes care of resource handling, releasing its permit after being complete.
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val release: Task[Unit]

Returns a task that upon evaluation will release a permit, returning it to the pool.
Returns a task that upon evaluation will release a permit, returning it to the pool.
If there are consumers waiting on permits being available, then the first in the queue will be selected and given a permit immediately.
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 Docs: object TaskSemaphore | package eval

final class TaskSemaphore extends Serializable

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val acquire: Task[Unit]

def activeCount: Coeval[Int]

final def asInstanceOf[T0]: T0

val awaitAllReleased: Task[Unit]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def greenLight[A](fa: Task[A]): Task[A]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val release: Task[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 Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped