NAME
APR::ThreadMutex - Perl API for XXX
Synopsis
use APR::ThreadMutex ();
META: to be completed
Description
META: to be completed
API
APR::ThreadMutex
provides the following functions and/or methods:
DESTROY
META: Autogenerated - needs to be reviewed/completed
Destroy the mutex and free the memory associated with the lock.
$mutex->DESTROY();
- arg1:
$mutex
(APR::ThreadMutex
) -
the mutex to destroy.
- ret: no return value
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.
$ret = $mutex->lock();
- arg1:
$mutex
(APR::ThreadMutex
) -
the mutex on which to acquire the lock.
- ret:
$ret
(integer)
pool_get
META: Autogenerated - needs to be reviewed/completed
Get the pool used by this thread_mutex.
$ret = $ob->pool_get();
- arg1:
$ob
(APR::ThreadMutex
) - ret:
$ret
(APR::Pool
) -
apr_pool_t the pool
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. 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();
- arg1:
$mutex
(APR::ThreadMutex
) -
the mutex on which to attempt the lock acquiring.
- ret:
$ret
(integer)
unlock
META: Autogenerated - needs to be reviewed/completed
Release the lock for the given mutex.
$ret = $mutex->unlock();
- arg1:
$mutex
(APR::ThreadMutex
) -
the mutex from which to release the lock.
- ret:
$ret
(integer)
See Also
Copyright
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 1.1.