Module Await_sync.Rwlock

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.

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.

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.

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.

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_shared w t ~f locks t for reading and runs f, providing it an aliased key for 'k. If t is locked for writing, then with_key_shared uses w to wait 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.

with_key_shared_freezing w t ~f is with_key_shared w t ~f, but freezes t if f raises an uncaught exception.

with_key_shared_or_cancel w c t ~f is Completed (with_key_shared w t ~f) if c is not canceled, otherwise it is Canceled

with_key_shared_or_cancel_freezing w c t ~f is with_key_shared_or_cancel w c t ~f, but freezes t if f raises an uncaught exception.

with_key w t ~f locks t for writing and runs f, providing it a key for 'k uniquely. If t is locked for reading or writing, then with_key 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_key_poisoning w t ~f is with_key w t ~f, but poisons t if f raises an uncaught exception.

with_key_or_cancel w c t ~f is Completed (with_key w t ~f) if c is not canceled, otherwise it is Canceled

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.

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.

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.

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.