docs::a...eadMutex(3)

💅 NAME 💅

okay so this page is docs::a...eadMutex(3), from the User Contributed Perl Documentation crew, and it's literally all about APR::ThreadMutex — the Perl API for APR thread mutexes. no cap. 💖

✨ Synopsis ✨

the whole vibe check, bestie:

use APR::ThreadMutex ();

my $mutex = APR::ThreadMutex->new($r->pool);
$mutex->lock;
$mutex->unlock;
$mutex->trylock;

🦋 Description 🦋

APR::ThreadMutex interfaces APR thread mutexes. that's the description, fr fr. 🦋

🔥 API 🔥

APR::ThreadMutex provides the following functions and/or methods — main character energy only:

💀 Unsupported API 💀

okay so APR::ThreadMutex also provides an auto-generated Perl interface for a few other methods which aren't tested at the moment, so their API is a subject to change 😭. these methods will be finalized later as a need arises.

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. 🫶

heads up: this is the “not officially supported yet” zone, iykyk.

🎀 DESTROY 🎀

META: Autogenerated - needs to be reviewed/completed

destroy the mutex and free the memory associated with the lock. not me cleaning up memory. 💀

$mutex->DESTROY();

• obj: $mutex ( "APR::ThreadMutex object" ) — the mutex to destroy.
• ret: no return value
• since: subject to change

🔒 lock 🔒

META: Autogenerated - needs to be reviewed/completed

acquire the lock for the given mutex. if the mutex is already locked, the current thread will be put to sleep until the lock becomes available 😴. the way that sounds so dramatic but it's literally the spec.

$ret = $mutex->lock();

• obj: $mutex ( "APR::ThreadMutex object" ) — the mutex on which to acquire the lock.
• ret: $ret ( integer )
• since: subject to change

✨ new ✨

create a new mutex. fresh mutex, new me, periodt. 💅

my $mutex = APR::ThreadMutex->new($p);

• obj: APR::ThreadMutex ( class name )
• arg1: $p ( "APR::Pool object" )
• ret: $mutex ( "APR::ThreadMutex 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_mutex. obsessed with pool access, ngl. 🏊

$ret = $obj->pool_get();

• obj: $obj ( "APR::ThreadMutex object" )
• ret: $ret ( "APR::Pool object" ) — apr_pool_t the pool
• since: subject to change

🎯 trylock 🎯

META: Autogenerated - needs to be reviewed/completed

attempt to acquire the lock for the given mutex. if the mutex has already been acquired, the call returns immediately with APR_EBUSY. 🚨

important: it is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine if the return value was APR_EBUSY, for portability reasons. highkey do not skip this.

$ret = $mutex->trylock();

• obj: $mutex ( "APR::ThreadMutex object" ) — the mutex on which to attempt the lock acquiring.
• ret: $ret (integer)
• since: subject to change

🔓 unlock 🔓

META: Autogenerated - needs to be reviewed/completed

release the lock for the given mutex. bye lock, ate. 👋

$ret = $mutex->unlock();

• obj: $mutex ( "APR::ThreadMutex object" ) — the mutex from which to release the lock.
• ret: $ret ( integer )
• since: subject to change

🌈 See Also 🌈

mod_perl 2.0 documentation. go read it, bestie. 📚

👑 Copyright 👑

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

🫶 Authors 🫶

The mod_perl development team and numerous contributors. iconic. 💖

---

okay that's the whole page, bestie. this one ships with perl v5.42.3, dated 2023-10-21, and it's docs::a...eadMutex(3). slay. 💅✨