libapa...dRWLock(3pm)

📦
version 2.0.13 · 12 versions
, in ubuntu stonking

💖 NAME 💖

APR::ThreadRWLock — it's the Perl API for APR thread read/write locks, bestie. Read/write locks, in Perl, from APR. Yes queen. 🎀

✨ Synopsis ✨

use APR::ThreadRWLock ();

my $mutex = APR::ThreadRWLock->new($r->pool);
$mutex->rdlock;
$mutex->wrlock;
$mutex->tryrdlock;
$mutex->trywrlock;
$mutex->unlock;

look at that. five little calls and you're locked in (literally). 🌸

🦋 Description 🦋

APR::ThreadRWLock is the interface to APR thread read/write locks. That's the whole vibe. 💅

If you wanna peek at the actual source, it's chilling in srclib/apr/locks/unix/thread_rwlock.c in your Apache source tree.

okay bestie listen — at the time of this writing these methods are not supported on all platforms. So check your libraries! Do not come crying to me when your platform says no. 🔥

👑 API 👑

APR::ThreadRWLock provides the following functions and/or methods:

💀 Unsupported API 💀

okay so APR::ThreadRWLock also hands you an auto-generated Perl interface for a few other methods, but ngl they aren't tested at the moment, so their API is a subject to change. They'll get finalized later as a need arises, fr fr.

If you want to rely on any of the following methods, please contact the the mod_perl development mailing list so we can help each other take the steps necessary to shift the method to an officially supported API. (yeah it says "the the", the original says "the the", we don't edit the sacred text 😭)

🌈 DESTROY

META: Autogenerated - needs to be reviewed/completed

Destroy the lock and free the associated memory. bye babes 👋

$lock->DESTROY();
  • obj: $lock ( APR::ThreadRWLock object ) — the lock to destroy.
  • ret: no return value
  • since: subject to change

🎀 rdlock

META: Autogenerated - needs to be reviewed/completed

Acquire the read lock for the given lock. The calling thread acquires the read lock if a writer does not hold the lock and there are no writers blocked on the lock. Otherwize it is put to sleep until these conditions are met. (yes, "Otherwize." iconic spelling, we keep it. ✨)

$ret = $lock->rdlock();
  • obj: $lock ( APR::ThreadRWLock object ) — the lock on which to acquire the lock.
  • ret: $ret ( integer )
  • since: subject to change

🧚 tryrdlock

META: Autogenerated - needs to be reviewed/completed

Performs the same operation as rdlock with the exception that the function shall fail if the thread would be blocked. no waiting around for you, bestie 💅

$ret = $lock->tryrdlock();
  • obj: $lock ( APR::ThreadRWLock object ) — the lock on which to acquire the lock.
  • ret: $ret ( integer )
  • since: subject to change

🔥 wrlock

META: Autogenerated - needs to be reviewed/completed

Acquire the write lock for the given lock. The calling thread acquires the write lock if if no other thread (reader or writer) holds it. Otherwize it is put to sleep until this condition is met. (double "if if" — we stan a typo we cannot touch 🫶)

$ret = $lock->wrlock();
  • obj: $lock ( APR::ThreadRWLock object ) — the lock on which to acquire the lock.
  • ret: $ret ( integer )
  • since: subject to change

⭐ trywrlock

META: Autogenerated - needs to be reviewed/completed

Performs the same operation as wrlock with the exception that the function shall fail if the thread would be blocked. main character energy: it does not wait in line. 🍓

$ret = $lock->trywrlock();
  • obj: $lock ( APR::ThreadRWLock object ) — the lock on which to acquire the lock.
  • ret: $ret ( integer )
  • since: subject to change

💜 new

Create a new lock. fresh out the box, slay.

my $lock = APR::ThreadRWLock->new($p);
  • obj: APR::ThreadRWLock ( class name )
  • arg1: $p ( APR::Pool object )
  • ret: $lock ( APR::ThreadRWLock object )
  • since: subject to change

🌸 pool_get

META: Autogenerated - needs to be reviewed/completed

META: should probably be renamed to pool(), like all other pool accessors

Get the pool used by this thread_lock.

$ret = $obj->pool_get();
  • obj: $obj ( APR::ThreadRWLock object )
  • ret: $ret ( APR::Pool object ) — apr_pool_t the pool
  • since: subject to change

🙈 unlock

META: Autogenerated - needs to be reviewed/completed

Release the lock for the given lock. let it goooo 🦋

$ret = $lock->unlock();
  • obj: $lock ( APR::ThreadRWLock object ) — the lock from which to release the lock.
  • ret: $ret ( integer )
  • since: subject to change

🌈 See Also 🌈

  • mod_perl 2.0 documentation.

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.

💖 Authors 💖

The mod_perl development team and numerous contributors.

and that's the whole page, no cap. this was libapa...dRWLock(3pm) — a User Contributed Perl Documentation joint, shipped with perl v5.42.3 and dated 2026-08-20. go lock something responsibly bestie 💅✨

📦 where this page comes from