.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "docs::api::APR::ThreadMutex 3pm"
.TH docs::api::APR::ThreadMutex 3pm 2024-03-29 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
APR::ThreadMutex \- Perl API for APR thread mutexes
.SH Synopsis
.IX Header "Synopsis"
.Vb 1
\&  use APR::ThreadMutex ();
\&
\&  my $mutex = APR::ThreadMutex\->new($r\->pool);
\&  $mutex\->lock;
\&  $mutex\->unlock;
\&  $mutex\->trylock;
.Ve
.SH Description
.IX Header "Description"
\&\f(CW\*(C`APR::ThreadMutex\*(C'\fR interfaces APR thread mutexes.
.SH API
.IX Header "API"
\&\f(CW\*(C`APR::ThreadMutex\*(C'\fR provides the following functions and/or methods:
.SH "Unsupported API"
.IX Header "Unsupported API"
\&\f(CW\*(C`APR::ThreadMutex\*(C'\fR 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.
.ie n .SS """DESTROY"""
.el .SS \f(CWDESTROY\fP
.IX Subsection "DESTROY"
META: Autogenerated \- needs to be reviewed/completed
.PP
Destroy the mutex and free the memory associated with the lock.
.PP
.Vb 1
\&  $mutex\->DESTROY();
.Ve
.ie n .IP "obj: $mutex ( ""APR::ThreadMutex object"" )" 4
.el .IP "obj: \f(CW$mutex\fR ( \f(CWAPR::ThreadMutex object\fR )" 4
.IX Item "obj: $mutex ( APR::ThreadMutex object )"
the mutex to destroy.
.IP "ret: no return value" 4
.IX Item "ret: no return value"
.PD 0
.IP "since: subject to change" 4
.IX Item "since: subject to change"
.PD
.ie n .SS """lock"""
.el .SS \f(CWlock\fP
.IX Subsection "lock"
META: Autogenerated \- needs to be reviewed/completed
.PP
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.
.PP
.Vb 1
\&  $ret = $mutex\->lock();
.Ve
.ie n .IP "obj: $mutex ( ""APR::ThreadMutex object"" )" 4
.el .IP "obj: \f(CW$mutex\fR ( \f(CWAPR::ThreadMutex object\fR )" 4
.IX Item "obj: $mutex ( APR::ThreadMutex object )"
the mutex on which to acquire the lock.
.ie n .IP "ret: $ret ( integer )" 4
.el .IP "ret: \f(CW$ret\fR ( integer )" 4
.IX Item "ret: $ret ( integer )"
.PD 0
.IP "since: subject to change" 4
.IX Item "since: subject to change"
.PD
.ie n .SS """new"""
.el .SS \f(CWnew\fP
.IX Subsection "new"
Create a new mutex
.PP
.Vb 1
\&  my $mutex = APR::ThreadMutex\->new($p);
.Ve
.ie n .IP "obj: ""APR::ThreadMutex"" ( class name )" 4
.el .IP "obj: \f(CWAPR::ThreadMutex\fR ( class name )" 4
.IX Item "obj: APR::ThreadMutex ( class name )"
.PD 0
.ie n .IP "arg1: $p ( ""APR::Pool object"" )" 4
.el .IP "arg1: \f(CW$p\fR ( \f(CWAPR::Pool object\fR )" 4
.IX Item "arg1: $p ( APR::Pool object )"
.ie n .IP "ret: $mutex ( ""APR::ThreadMutex object"" )" 4
.el .IP "ret: \f(CW$mutex\fR ( \f(CWAPR::ThreadMutex object\fR )" 4
.IX Item "ret: $mutex ( APR::ThreadMutex object )"
.IP "since: subject to change" 4
.IX Item "since: subject to change"
.PD
.ie n .SS """pool_get"""
.el .SS \f(CWpool_get\fP
.IX Subsection "pool_get"
META: Autogenerated \- needs to be reviewed/completed
.PP
META: should probably be renamed to \fBpool()\fR, like all other pool
accessors
.PP
Get the pool used by this thread_mutex.
.PP
.Vb 1
\&  $ret = $obj\->pool_get();
.Ve
.ie n .IP "obj: $obj ( ""APR::ThreadMutex object"" )" 4
.el .IP "obj: \f(CW$obj\fR ( \f(CWAPR::ThreadMutex object\fR )" 4
.IX Item "obj: $obj ( APR::ThreadMutex object )"
.PD 0
.ie n .IP "ret: $ret ( ""APR::Pool object"" )" 4
.el .IP "ret: \f(CW$ret\fR ( \f(CWAPR::Pool object\fR )" 4
.IX Item "ret: $ret ( APR::Pool object )"
.PD
apr_pool_t the pool
.IP "since: subject to change" 4
.IX Item "since: subject to change"
.ie n .SS """trylock"""
.el .SS \f(CWtrylock\fP
.IX Subsection "trylock"
META: Autogenerated \- needs to be reviewed/completed
.PP
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.
.PP
.Vb 1
\&  $ret = $mutex\->trylock();
.Ve
.ie n .IP "obj: $mutex ( ""APR::ThreadMutex object"" )" 4
.el .IP "obj: \f(CW$mutex\fR ( \f(CWAPR::ThreadMutex object\fR )" 4
.IX Item "obj: $mutex ( APR::ThreadMutex object )"
the mutex on which to attempt the lock acquiring.
.ie n .IP "ret: $ret (integer)" 4
.el .IP "ret: \f(CW$ret\fR (integer)" 4
.IX Item "ret: $ret (integer)"
.PD 0
.IP "since: subject to change" 4
.IX Item "since: subject to change"
.PD
.ie n .SS """unlock"""
.el .SS \f(CWunlock\fP
.IX Subsection "unlock"
META: Autogenerated \- needs to be reviewed/completed
.PP
Release the lock for the given mutex.
.PP
.Vb 1
\&  $ret = $mutex\->unlock();
.Ve
.ie n .IP "obj: $mutex ( ""APR::ThreadMutex object"" )" 4
.el .IP "obj: \f(CW$mutex\fR ( \f(CWAPR::ThreadMutex object\fR )" 4
.IX Item "obj: $mutex ( APR::ThreadMutex object )"
the mutex from which to release the lock.
.ie n .IP "ret: $ret ( integer )" 4
.el .IP "ret: \f(CW$ret\fR ( integer )" 4
.IX Item "ret: $ret ( integer )"
.PD 0
.IP "since: subject to change" 4
.IX Item "since: subject to change"
.PD
.SH "See Also"
.IX Header "See Also"
mod_perl 2.0 documentation.
.SH Copyright
.IX Header "Copyright"
mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.
.SH Authors
.IX Header "Authors"
The mod_perl development team and numerous
contributors.