A protocol for locks. More...
#include <ObjFW/OFLocking.h>
Inheritance diagram for <OFLocking>:
Instance Methods | |
| (void) | - lock |
| Locks the lock. | |
| (bool) | - tryLock |
| Tries to lock the lock. | |
| (void) | - unlock |
| Unlocks the lock. | |
 Instance Methods inherited from <OFObject> | |
| (Class) | - class |
| Returns the class of the object. | |
| (nullable Class) | - superclass |
| Returns the superclass of the object. | |
| (unsigned long) | - hash |
| Returns a hash for the object. | |
| (unsigned int) | - retainCount |
| Returns the retain count. | |
| (bool) | - isProxy |
| Returns whether the object is a proxy object. | |
| (bool) | - isKindOfClass: |
| Returns a boolean whether the object is of the specified kind. | |
| (bool) | - isMemberOfClass: |
| Returns a boolean whether the object is a member of the specified class. | |
| (bool) | - respondsToSelector: |
| Returns a boolean whether the object responds to the specified selector. | |
| (bool) | - conformsToProtocol: |
| Checks whether the object conforms to the specified protocol. | |
| (nullable IMP) | - methodForSelector: |
| Returns the implementation for the specified selector. | |
| (nullable id) | - performSelector: |
| Performs the specified selector. | |
| (nullable id) | - performSelector:withObject: |
| Performs the specified selector with the specified object. | |
| (nullable id) | - performSelector:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (nullable id) | - performSelector:withObject:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (nullable id) | - performSelector:withObject:withObject:withObject:withObject: |
| Performs the specified selector with the specified objects. | |
| (bool) | - isEqual: |
| Checks two objects for equality. | |
| (instancetype) | - retain |
| Increases the retain count. | |
| (void) | - release |
| Decreases the retain count. | |
| (instancetype) | - autorelease |
| Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. | |
| (instancetype) | - self |
| Returns the receiver. | |
| (bool) | - allowsWeakReference |
| Returns whether the object allows a weak reference. | |
| (bool) | - retainWeakReference |
| Retain a weak reference to this object. | |
Properties | |
| OFString * | name |
| The name of the lock. | |
Detailed Description
A protocol for locks.
Method Documentation
◆ lock
| - (void) lock |
Locks the lock.
- Exceptions
-
OFLockFailedException Acquiring the lock failed
◆ tryLock
| - (bool) tryLock |
Tries to lock the lock.
- Returns
- A boolean whether the lock could be locked
- Exceptions
-
OFLockFailedException The lock could not be acquired for another reason than it already being held
◆ unlock
| - (void) unlock |
Unlocks the lock.
- Exceptions
-
OFUnlockFailedException Releasing the lock failed
The documentation for this protocol was generated from the following file:
- src/OFLocking.h
