APR::ThreadMutex - Perl API for APR thread mutexes
use APR::ThreadMutex (); my $mutex = APR::ThreadMutex->new($r->pool); $mutex->lock; $mutex->unlock; $mutex->trylock;
APR::ThreadMutex interfaces APR thread mutexes.
APR::ThreadMutex
APR::ThreadMutex provides the following functions and/or methods:
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 mod_perl development mailing list so we can help each other take the steps necessary to shift the method to an officially supported API.
DESTROY
META: Autogenerated - needs to be reviewed/completed
Destroy the mutex and free the memory associated with the lock.
$mutex->DESTROY();
$mutex
APR::ThreadMutex object
the mutex to destroy.
lock
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();
the mutex on which to acquire the lock.
$ret
new
Create a new mutex
my $mutex = APR::ThreadMutex->new($p);
$p
APR::Pool object
pool_get
META: should probably be renamed to pool(), like all other pool accessors
Get the pool used by this thread_mutex.
$ret = $obj->pool_get();
$obj
apr_pool_t the pool
trylock
Attempt to acquire the lock for the given mutex. If the mutex has already been acquired, the call returns immediately with APR_EBUSY. Note: 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.
$ret = $mutex->trylock();
the mutex on which to attempt the lock acquiring.
unlock
Release the lock for the given mutex.
$ret = $mutex->unlock();
the mutex from which to release the lock.
mod_perl 2.0 documentation.
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.
The mod_perl development team and numerous contributors.
To install mod_perl2, copy and paste the appropriate command in to your terminal.
cpanm
cpanm mod_perl2
CPAN shell
perl -MCPAN -e shell install mod_perl2
For more information on module installation, please visit the detailed CPAN module installation guide.