GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  APR::THREADMUTEX (3)

.ds Aq ’

NAME

APR::ThreadMutex - Perl API for APR thread mutexes

CONTENTS

Synopsis



  use APR::ThreadMutex ();

  my $mutex = APR::ThreadMutex->new($r->pool);
  $mutex->lock;
  $mutex->unlock;
  $mutex->trylock;



Description

APR::ThreadMutex interfaces APR thread mutexes.

API

APR::ThreadMutex provides the following functions and/or methods:

Unsupported API

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.

CWDESTROY

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

CWlock

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

CWnew

Create a new mutex



  my $mutex = APR::ThreadMutex->new($p);



obj: APR::ThreadMutex ( class name )
arg1: $p ( APR::Pool object )
ret: $mutex ( APR::ThreadMutex object )
since: subject to change

CWpool_get

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 thread_mutex.



  $ret = $obj->pool_get();



obj: $obj ( APR::ThreadMutex object )
ret: $ret ( APR::Pool object ) apr_pool_t the pool
since: subject to change

CWtrylock

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();



obj: $mutex ( APR::ThreadMutex object ) the mutex on which to attempt the lock acquiring.
ret: $ret (integer)
since: subject to change

CWunlock

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

See Also

mod_perl 2.0 documentation.

Copyright

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.

Authors

The mod_perl development team and numerous contributors.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 WORK::MOD_PERL-2.0.9::DOCS::API::APR::THREADMUTEX (3) 2015-06-18

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.