.\" -*- 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::ThreadRWLock 3pm"
.TH docs::api::APR::ThreadRWLock 3pm 2024-01-10 "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::ThreadRWLock \- Perl API for APR thread read/write locks
.SH Synopsis
.IX Header "Synopsis"
.Vb 1
\&  use APR::ThreadRWLock ();
\&
\&  my $mutex = APR::ThreadRWLock\->new($r\->pool);
\&  $mutex\->rdlock;
\&  $mutex\->wrlock;
\&  $mutex\->tryrdlock;
\&  $mutex\->trywrlock;
\&  $mutex\->unlock;
.Ve
.SH Description
.IX Header "Description"
\&\f(CW\*(C`APR::ThreadRWLock\*(C'\fR interfaces APR thread read/write locks.
.PP
See \fIsrclib/apr/locks/unix/thread_rwlock.c\fR in your Apache source tree.
At the time of this writing these methods are not supported on all
platforms. Thus, check your libraries!
.SH API
.IX Header "API"
\&\f(CW\*(C`APR::ThreadRWLock\*(C'\fR provides the following functions and/or methods:
.SH "Unsupported API"
.IX Header "Unsupported API"
\&\f(CW\*(C`APR::ThreadRWLock\*(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 lock and free the associated memory.
.PP
.Vb 1
\&  $lock\->DESTROY();
.Ve
.ie n .IP "obj: $lock ( ""APR::ThreadRWLock object"" )" 4
.el .IP "obj: \f(CW$lock\fR ( \f(CWAPR::ThreadRWLock object\fR )" 4
.IX Item "obj: $lock ( APR::ThreadRWLock object )"
the lock 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 """rdlock"""
.el .SS \f(CWrdlock\fP
.IX Subsection "rdlock"
META: Autogenerated \- needs to be reviewed/completed
.PP
Acquire the read lock for the given lock. The calling thread acquires the
read lock if a writer does not hold the lock and there are  no  writers
blocked on the lock. Otherwize it is put to sleep until these conditions
are met.
.PP
.Vb 1
\&  $ret = $lock\->rdlock();
.Ve
.ie n .IP "obj: $lock ( ""APR::ThreadRWLock object"" )" 4
.el .IP "obj: \f(CW$lock\fR ( \f(CWAPR::ThreadRWLock object\fR )" 4
.IX Item "obj: $lock ( APR::ThreadRWLock object )"
the lock 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 """tryrdlock"""
.el .SS \f(CWtryrdlock\fP
.IX Subsection "tryrdlock"
META: Autogenerated \- needs to be reviewed/completed
.PP
Performs the same operation as \f(CW\*(C`rdlock\*(C'\fR with the exception that the
function shall fail if the thread would be blocked.
.PP
.Vb 1
\&  $ret = $lock\->tryrdlock();
.Ve
.ie n .IP "obj: $lock ( ""APR::ThreadRWLock object"" )" 4
.el .IP "obj: \f(CW$lock\fR ( \f(CWAPR::ThreadRWLock object\fR )" 4
.IX Item "obj: $lock ( APR::ThreadRWLock object )"
the lock 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 """wrlock"""
.el .SS \f(CWwrlock\fP
.IX Subsection "wrlock"
META: Autogenerated \- needs to be reviewed/completed
.PP
Acquire the write lock for the given lock. The calling thread acquires the
write lock if if no other thread (reader or writer) holds it. Otherwize it
is put to sleep until this condition is met.
.PP
.Vb 1
\&  $ret = $lock\->wrlock();
.Ve
.ie n .IP "obj: $lock ( ""APR::ThreadRWLock object"" )" 4
.el .IP "obj: \f(CW$lock\fR ( \f(CWAPR::ThreadRWLock object\fR )" 4
.IX Item "obj: $lock ( APR::ThreadRWLock object )"
the lock 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 """trywrlock"""
.el .SS \f(CWtrywrlock\fP
.IX Subsection "trywrlock"
META: Autogenerated \- needs to be reviewed/completed
.PP
Performs the same operation as \f(CW\*(C`wrlock\*(C'\fR with the exception that the
function shall fail if the thread would be blocked.
.PP
.Vb 1
\&  $ret = $lock\->trywrlock();
.Ve
.ie n .IP "obj: $lock ( ""APR::ThreadRWLock object"" )" 4
.el .IP "obj: \f(CW$lock\fR ( \f(CWAPR::ThreadRWLock object\fR )" 4
.IX Item "obj: $lock ( APR::ThreadRWLock object )"
the lock 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 lock
.PP
.Vb 1
\&  my $lock = APR::ThreadRWLock\->new($p);
.Ve
.ie n .IP "obj: ""APR::ThreadRWLock"" ( class name )" 4
.el .IP "obj: \f(CWAPR::ThreadRWLock\fR ( class name )" 4
.IX Item "obj: APR::ThreadRWLock ( 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: $lock ( ""APR::ThreadRWLock object"" )" 4
.el .IP "ret: \f(CW$lock\fR ( \f(CWAPR::ThreadRWLock object\fR )" 4
.IX Item "ret: $lock ( APR::ThreadRWLock 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_lock.
.PP
.Vb 1
\&  $ret = $obj\->pool_get();
.Ve
.ie n .IP "obj: $obj ( ""APR::ThreadRWLock object"" )" 4
.el .IP "obj: \f(CW$obj\fR ( \f(CWAPR::ThreadRWLock object\fR )" 4
.IX Item "obj: $obj ( APR::ThreadRWLock 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 """unlock"""
.el .SS \f(CWunlock\fP
.IX Subsection "unlock"
META: Autogenerated \- needs to be reviewed/completed
.PP
Release the lock for the given lock.
.PP
.Vb 1
\&  $ret = $lock\->unlock();
.Ve
.ie n .IP "obj: $lock ( ""APR::ThreadRWLock object"" )" 4
.el .IP "obj: \f(CW$lock\fR ( \f(CWAPR::ThreadRWLock object\fR )" 4
.IX Item "obj: $lock ( APR::ThreadRWLock object )"
the lock 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.