Packages

final class TSemaphore extends Serializable

A TSemaphore is a semaphore that can be composed transactionally. Because of the extremely high performance of ZIO's implementation of software transactional memory TSemaphore can support both controlling access to some resource on a standalone basis as well as composing with other STM data structures to solve more advanced concurrency problems.

For basic use cases, the most idiomatic way to work with a semaphore is to use the withPermit operator, which acquires a permit before executing some ZIO effect and release the permit immediately afterward. The permit is guaranteed to be released immediately after the effect completes execution, whether by success, failure, or interruption. Attempting to acquire a permit when a sufficient number of permits are not available will semantically block until permits become available without blocking any underlying operating system threads. If you want to acquire more than one permit at a time you can use withPermits, which allows specifying a number of permits to acquire. You can also use withPermitScoped or withPermitsScoped to acquire and release permits within the context of a scoped effect for composing with other resources.

For more advanced concurrency problems you can use the acquire and release operators directly, or their variants acquireN and releaseN, all of which return STM transactions. Thus, they can be composed to form larger STM transactions, for example acquiring permits from two different semaphores transactionally and later releasing them transactionally to safely synchronize on access to two different mutable variables.

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TSemaphore
  2. Serializable
  3. Serializable
  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. def acquire: USTM[Unit]

    Acquires a single permit in transactional context.

  5. def acquireBetween(min: Long, max: Long): USTM[Long]

    Acquire at least min permits and at most max permits in a transactional context.

  6. def acquireN(n: Long): USTM[Unit]

    Acquires the specified number of permits in a transactional context.

  7. def acquireUpTo(max: Long): USTM[Long]

    Acquire at most max permits in a transactional context.

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def available: USTM[Long]

    Returns the number of available permits in a transactional context.

  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. val permits: TRef[Long]
  20. def release: USTM[Unit]

    Releases a single permit in a transactional context.

  21. def releaseN(n: Long): USTM[Unit]

    Releases the specified number of permits in a transactional context

  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. def tryAcquire: USTM[Boolean]

    Tries to acquire a single permit in a transactional context.

    Tries to acquire a single permit in a transactional context. Returns true if the permit was acquired, otherwise false.

  25. def tryAcquireN(n: Long): USTM[Boolean]

    Tries to acquire the specified number of permits in a transactional context.

    Tries to acquire the specified number of permits in a transactional context. Returns true if the permits were acquired, otherwise false.

  26. def tryWithPermit[R, E, A](zio: ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, Option[A]]

    Executes the specified effect, acquiring 1 permit if available and releasing them after execution.

    Executes the specified effect, acquiring 1 permit if available and releasing them after execution. Returns None if no permits were available.

  27. def tryWithPermits[R, E, A](n: Long)(zio: ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, Option[A]]

    Executes the specified effect, acquiring n permits if available and releasing them after execution.

    Executes the specified effect, acquiring n permits if available and releasing them after execution. Returns None if no permits were available.

  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def withPermit[R, E, A](zio: ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]

    Executes the specified effect, acquiring a permit immediately before the effect begins execution and releasing it immediately after the effect completes execution, whether by success, failure, or interruption.

  32. def withPermitScoped(implicit trace: Trace): ZIO[Scope, Nothing, Unit]

    Returns a scoped effect that describes acquiring a permit as the acquire action and releasing it as the release action.

  33. def withPermits[R, E, A](n: Long)(zio: ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]

    Executes the specified effect, acquiring the specified number of permits immediately before the effect begins execution and releasing them immediately after the effect completes execution, whether by success, failure, or interruption.

  34. def withPermitsBetween[R, E, A](min: Long, max: Long)(zio: (Long) ⇒ ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]

    Executes the specified effect, acquiring at least min and at most max permits immediately before the effect begins execution and releasing them immediately after the effect completes execution, whether by success, failure, or interruption.

  35. def withPermitsBetweenScoped(min: Long, max: Long)(implicit trace: Trace): ZIO[Scope, Nothing, Long]

    Returns a scoped effect that describes acquiring at least min and at most max permits and releasing them when the scope is closed.

  36. def withPermitsScoped(n: Long)(implicit trace: Trace): ZIO[Scope, Nothing, Unit]

    Returns a scoped effect that describes acquiring the specified number of permits and releasing them when the scope is closed.

  37. def withPermitsUpTo[R, E, A](max: Long)(zio: (Long) ⇒ ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]

    Executes the specified effect, acquiring at most the specified number of permits immediately before the effect begins execution and releasing them immediately after the effect completes execution, whether by success, failure, or interruption.

  38. def withPermitsUpToScoped(max: Long)(implicit trace: Trace): ZIO[Scope, Nothing, Long]

    Returns a scoped effect that describes acquiring at most max permits and releasing them when the scope is closed.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped