Module Await.RwlockSource

k t is the type of a read/write lock protecting the contents of the k capsule.

create k creates a new reader-writer lock for the capsule 'k associated with k, consuming the key itself.

The optional padded argument specifies whether to pad the data structure to avoid false sharing. See Atomic.make for a longer explanation.

with_access_shared w t ~f acquires t for reading, runs f with shared access to the associated capsule, then releases t. If t is locked for writing then uses w to wait until it is unlocked.

• raises Poisoned

  if t cannot be acquired because it is poisoned.

• raises Terminated

  if w is terminated before the lock is acquired.

with_access_shared_freezing w t ~f is with_access_shared w t ~f, but freezes t if f raises an uncaught exception.

try_with_access_shared t ~f attempts to acquire t for reading without blocking. If successful, it runs f as with_access_shared would, but without taking a Await.t because no waiting is needed. Otherwise, it is Would_block.

try_with_access_shared_freezing t ~f is try_with_access_shared t ~f, but freezes t if f raises an uncaught exception.

with_access_shared_or_cancel w c t ~f is Completed (with_access_shared w t ~f) if c is not canceled, otherwise it is Canceled.

with_access_shared_or_cancel_freezing w c t ~f is with_access_shared_or_cancel w c t ~f, but freezes t if f raises an uncaught exception.

with_access w t ~f acquires t for writing, runs f within the associated capsule, then releases t. If t is locked then uses w to wait until it is unlocked.

• raises Poisoned

  if t cannot be acquired because it is poisoned.

• raises Frozen

  if t cannot be acquired for writing because it is frozen.

• raises Terminated

  if w is terminated before the lock is acquired.

with_access_poisoning w t ~f is with_access w t ~f, but poisons t if f raises an uncaught exception.

try_with_access t ~f attempts to acquire t for writing without blocking. If successful, it runs f as with_access would, but without taking an Await.t because no waiting is needed. Otherwise, it is Would_block.

try_with_access_poisoning t ~f is try_with_access t ~f, but poisons t if f raises an uncaught exception.

with_access_or_cancel w c t ~f is Completed (with_access w t ~f) if c is not canceled, otherwise it is Canceled.

with_access_or_cancel_poisoning w c t ~f is with_access_or_cancel w c t ~f, but poisons t if f raises an uncaught exception.

with_password_shared w t ~f acquires t, runs f with permission to access the associated capsule, then releases t. If t is locked then uses w to wait until it is unlocked.

• raises Poisoned

  if t cannot be acquired because it is poisoned.

• raises Terminated

  if w is terminated before the lock is acquired.

with_password_shared_freezing w t ~f is with_password_shared w t ~f, but freezes t if f raises an uncaught exception.

try_with_password_shared t ~f attempts to acquire t for reading without blocking. If successful, it runs f as with_password_shared would, but without taking an Await.t because no waiting is needed. Otherwise, it is Would_block.

try_with_password_shared_freezing t ~f is try_with_password_shared t ~f, but freezes t if f raises an uncaught exception.

with_password_shared_or_cancel w c t ~f is Completed (with_password_shared w t ~f) if c is not canceled, otherwise it is Canceled.

with_password_shared_or_cancel_freezing w c t ~f is with_password_shared_or_cancel w t ~f, but freezes t if f raises an uncaught exception.

with_password w t ~f acquires t, runs f with permission to access the associated capsule, then releases t. If t is locked then uses w to wait until it is unlocked.

• raises Poisoned

  if t cannot be acquired because it is poisoned.

• raises Frozen

  if t cannot be acquired for writing because it is frozen.

• raises Terminated

  if w is terminated before the lock is acquired.

with_password_poisoning w t ~f is with_password w t ~f, but poisons t if f raises an uncaught exception.

try_with_password t ~f attempts to acquire t for writing without blocking. If successful, it runs f as with_password would, but without taking an Await.t because no waiting is needed. Otherwise, it is Would_block.

try_with_password_poisoning t ~f is try_with_password t ~f, but poisons t if f raises an uncaught exception.

with_password_or_cancel w c t ~f is Completed (with_password w t ~f) if c is not canceled, otherwise it is Canceled.

with_password_or_cancel_poisoning w c t ~f is with_password_or_cancel w c t ~f, but poisons t if f raises an uncaught exception.

with_key_poisoning w t ~f is with_key w t ~f, but poisons t if f raises an uncaught exception.

try_with_key_poisoning t ~f attempts to acquire t for writing without blocking. If successful, it runs f as with_key_poisoning would, but without taking a Await.t because no waiting is needed. Otherwise, it is Would_block.

with_key_or_cancel_poisoning w c t ~f is with_key_or_cancel w c t ~f, but poisons t if f raises an uncaught exception.

Condition variable for waiting for changes to state protected by a lock.

with_key_and_condition_wait_poisoning w t ~f locks t and runs f, providing it with a key for 'k uniquely and a 'k Condition.Wait.t which provides the ability to temporarily unlock t and wait on an associated 'k Condition.t.

The lock is only poisoned if f raises while the lock held; if waiting on a condition variable is terminated or if the callback passed to Condition.Wait.release_temporarily raises, the lock will not be poisoned.

• raises Poisoned

  if t cannot be acquired because it is poisoned.

• raises Terminated

  if w is terminated before the mutex is acquired.

with_key_and_condition_wait_or_cancel_poisoining w c t ~f is Completed (with_key_and_condition_wait_poisoining w t ~f) if c is not canceled, otherwise it is Canceled.

poison t key poisons the rwlock associated with the key.

Note that poisoning a rwlock does not signal waiters on associated condition variables.

acquire_shared w t acquires t for reading and returns a Shared_guard.t for the lock. If t is already locked for writing, acquire_shared uses w to block until it is only locked for reading.

• raises Poisoned

  if t cannot be acquired because it is poisoned.

• raises Terminated

  if w is terminated before the lock is acquired.

try_acquire_shared t attempts to acquire t for reading without blocking, and does not take an Await.t because no waiting is needed. It is Would_block if t is locked for writing.

• raises Poisoned

  if t cannot be acquired because it is poisoned.

acquire_shared_or_cancel w c t is Completed (acquire_shared w t) if c is not canceled, otherwise it is Canceled.

• raises Poisoned

  if t cannot be acquired because it is poisoned.

• raises Terminated

  if w is terminated before the lock is acquired, even if c is canceled.

acquire w t acquires t for writing and returns a Write_guard.t for the lock. If t is already locked for reading or writing, acquire uses w to block until it is unlocked.

• raises Poisoned

  if t cannot be acquired because it is poisoned.

• raises Frozen

  if t cannot be acquired for writing because it is frozen.

• raises Terminated

  if w is terminated before the lock is acquired.

try_acquire t attempts to acquire t for writing without blocking, and does not take an Await.t because no waiting is needed. It is Would_block if t is locked.

• raises Poisoned

  if t cannot be acquired because it is poisoned.

• raises Frozen

  if t cannot be acquired for writing because it is frozen.

acquire_or_cancel w c t is Completed (acquire w t) if c is not canceled, otherwise it is Canceled.

• raises Poisoned

  if t cannot be acquired because it is poisoned.

• raises Frozen

  if t cannot be acquired for writing because it is frozen.

• raises Terminated

  if w is terminated before the lock is acquired, even if c is canceled.

is_poisoned t is true if the reader-writer lock t is poisoned.

is_frozen t is true if the reader-writer lock t is frozen.