libs-base/Documentation/gsdoc/NSRecursiveLock.gsdoc
nico aabec6bdae Documented GSDebugAllocation functions in NSFunctions; fixed syntax error
in NSRecursiveLock


git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@9629 72102866-910b-0410-8b05-ffd578937521
2001-04-19 17:25:36 +00:00

46 lines
1.7 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.6//EN" "http://www.gnustep.org/gsdoc-0_6_6.xml">
<gsdoc base="NSRecursiveLock" prev="NSProxy" next="NSRunLoop" up="Base">
<head>
<title>NSRecursiveLock</title>
<author name="Adam Fedor">
<email address="fedor@gnu.org"/>
<url url="http://www.gnustep.org/developers/whoiswho.html"/>
</author>
<version>$Revision$</version>
<date>$Date$</date>
</head>
<body>
<chapter>
<heading>NSRecursiveLock</heading>
<class name="NSRecursiveLock" super="NSObject">
<declared>Foundation/NSLock.h</declared>
<conform>NSLocking</conform>
<desc>
See NSLock for more information about what a lock is. A recursive
lock extends NSLock in that you can lock a recursive lock multiple
times. Each lock must be balanced by a cooresponding unlock, and the
lock is not released for another thread to aquire until the last
unlock call is made (cooresponding to the fist lock message).
</desc>
<method type="BOOL">
<sel>lockBeforeDate:</sel>
<arg type="NSDate*">limit</arg>
<desc>
Attempts to aquire a lock before the date limit passes. It returns
YES if it can. It returns NO if it cannot
(but it waits until the time limit is up before returning NO).
</desc>
</method>
<method type="BOOL">
<sel>tryLock</sel>
<desc>
Attempts to aquire a lock, but returns NO immediately if the lock
cannot be aquired. It returns YES if the lock is aquired. Can be
called multiple times to make nested locks.
</desc>
</method>
</class>
</chapter>
</body>
</gsdoc>