Packages

final class TReentrantLock extends AnyRef

A TReentrantLock is a reentrant read/write lock. Multiple readers may all concurrently acquire read locks. Only one writer is allowed to acquire a write lock at any given time. Read locks may be upgraded into write locks. A fiber that has a write lock may acquire other write locks or read locks.

The two primary methods of this structure are readLock, which acquires a read lock in a scoped context, and writeLock, which acquires a write lock in a scoped context.

Although located in the STM package, there is no need for locks within STM transactions. However, this lock can be quite useful in effectful code, to provide consistent read/write access to mutable state; and being in STM allows this structure to be composed into more complicated concurrent structures that are consumed from effectful code.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TReentrantLock
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. 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. lazy val acquireRead: USTM[Int]

    Acquires a read lock.

    Acquires a read lock. The transaction will suspend until no other fiber is holding a write lock. Succeeds with the number of read locks held by this fiber.

  5. lazy val acquireWrite: USTM[Int]

    Acquires a write lock.

    Acquires a write lock. The transaction will suspend until no other fibers are holding read or write locks. Succeeds with the number of write locks held by this fiber.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. def fiberReadLocks: USTM[Int]

    Retrieves the number of acquired read locks for this fiber.

  11. def fiberWriteLocks: USTM[Int]

    Retrieves the number of acquired write locks for this fiber.

  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def lock(implicit trace: Trace): ZIO[Scope, Nothing, Int]

    Just a convenience method for applications that only need reentrant locks, without needing a distinction between readers / writers.

    Just a convenience method for applications that only need reentrant locks, without needing a distinction between readers / writers.

    See writeLock.

  16. def locked: USTM[Boolean]

    Determines if any fiber has a read or write lock.

  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. def readLock(implicit trace: Trace): ZIO[Scope, Nothing, Int]

    Obtains a read lock in a scoped context.

  21. def readLocked: USTM[Boolean]

    Determines if any fiber has a read lock.

  22. def readLocks: USTM[Int]

    Retrieves the total number of acquired read locks.

  23. lazy val releaseRead: USTM[Int]

    Releases a read lock held by this fiber.

    Releases a read lock held by this fiber. Succeeds with the outstanding number of read locks held by this fiber.

  24. lazy val releaseWrite: USTM[Int]

    Releases a write lock held by this fiber.

    Releases a write lock held by this fiber. Succeeds with the outstanding number of write locks held by this fiber.

  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. def withLock[R, E, A](zio: ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]

    Runs the specified workflow with a lock.

  31. def withReadLock[R, E, A](zio: ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]

    Runs the specified workflow with a read lock.

  32. def withWriteLock[R, E, A](zio: ZIO[R, E, A])(implicit trace: Trace): ZIO[R, E, A]

    Runs the specified workflow with a write lock.

  33. def writeLock(implicit trace: Trace): ZIO[Scope, Nothing, Int]

    Obtains a write lock in a scoped context.

  34. def writeLocked: USTM[Boolean]

    Determines if a write lock is held by some fiber.

  35. def writeLocks: USTM[Int]

    Computes the number of write locks held by fibers.

Deprecated Value Members

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

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped