NAME
APR::ThreadMutex - Perl API for APR thread mutexES
SSyynnooppssiissuse APR::ThreadMutex ();
my $mutex = APR::ThreadMutex->new($r->pool);
$mutex->lock;
$mutex->unlock;
$mutex->trylock;
DDeessccrriippttiioonn"APR::ThreadMutex" interfaces APR thread mutexes.
AAPPII"APR::ThreadMutex" provides the following functions and/or methods:
UUnnssuuppppoorrtteedd AAPPII"APR::ThreadMutex" also provides auto-generated Perl interface for a
few other methods which aren't tested at the moment and therefore 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 modperl development mailing list so we can help each other take the steps necessary to shift the method to an officially supported API. ""DDEESSTTRROOYY""META: Autogenerated - needs to be reviewed/completed
Destroy the mutex and free the memory associated with the lock.$mutex->DESTROY();
obj: $mutex ( "APR::ThreadMutex object" )
the mutex to destroy. ret: no return value since: subject to change ""lloocckk""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.$ret = $mutex->lock();
obj: $mutex ( "APR::ThreadMutex object" )
the mutex on which to acquire the lock.ret: $ret ( integer )
since: subject to change ""nneeww"" Create a new mutexmy $mutex = APR::ThreadMutex->new($p);
obj: "APR::ThreadMutex" ( class name )
arg1: $p ( "APR::Pool object" )
ret: $mutex ( "APR::ThreadMutex object" )
since: subject to change ""ppoooollggeett""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 threadmutex.$ret = $obj->poolget();
obj: $obj ( "APR::ThreadMutex object" )
ret: $ret ( "APR::Pool object" )
aprpoolt the pool since: subject to change ""ttrryylloocckk""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 APREBUSY. Note: it is important that the APRSTATUSISEBUSY(s) macro be used to determine if the return value was APREBUSY, for portability reasons.$ret = $mutex->trylock();
obj: $mutex ( "APR::ThreadMutex object" )
the mutex on which to attempt the lock acquiring.ret: $ret (integer)
since: subject to change ""uunnlloocckk""META: Autogenerated - needs to be reviewed/completed
Release the lock for the given mutex.$ret = $mutex->unlock();
obj: $mutex ( "APR::ThreadMutex object" )
the mutex from which to release the lock.ret: $ret ( integer )
since: subject to change SSeeee AAllssoo modperl 2.0 documentation. CCooppyyrriigghhtt modperl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0. AAuutthhoorrss The modperl development team and numerous contributors.perl v5.a8p.a8chemodperl-101.1~2::mo2d00p5e-r1l0-22.00.2::docs::api::APR::ThreadMutex(3)