ObjFW
Instance Methods | Properties | List of all members
<OFLocking> Protocol Reference

A protocol for locks. More...

#import <ObjFW/OFLocking.h>

Inheritance diagram for <OFLocking>:
<OFObject> OFMutex OFRecursiveMutex OFCondition

Instance Methods

(void) - lock
 Locks the lock. More...
 
(bool) - tryLock
 Tries to lock the lock. More...
 
(void) - unlock
 Unlocks the lock. More...
 
- Instance Methods inherited from <OFObject>
(Class) - class
 Returns the class of the object. More...
 
(nullable Class) - superclass
 Returns the superclass of the object. More...
 
(unsigned long) - hash
 Returns a hash for the object. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 
(bool) - isKindOfClass:
 Returns a boolean whether the object is of the specified kind. More...
 
(bool) - isMemberOfClass:
 Returns a boolean whether the object is a member of the specified class. More...
 
(bool) - respondsToSelector:
 Returns a boolean whether the object responds to the specified selector. More...
 
(bool) - conformsToProtocol:
 Checks whether the object conforms to the specified protocol. More...
 
(nullable IMP- methodForSelector:
 Returns the implementation for the specified selector. More...
 
(nullable id) - performSelector:
 Performs the specified selector. More...
 
(nullable id) - performSelector:withObject:
 Performs the specified selector with the specified object. More...
 
(nullable id) - performSelector:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(nullable id) - performSelector:withObject:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(nullable id) - performSelector:withObject:withObject:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(instancetype) - retain
 Increases the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(instancetype) - autorelease
 Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. More...
 
(instancetype) - self
 Returns the receiver. More...
 
(bool) - allowsWeakReference
 Returns whether the object allows a weak reference. More...
 
(bool) - retainWeakReference
 Retain a weak reference to this object. More...
 

Properties

OFStringname
 The name of the lock.
 

Detailed Description

A protocol for locks.

Method Documentation

◆ lock

- (void) lock

Locks the lock.

Exceptions
OFLockFailedExceptionAcquiring the lock failed

◆ tryLock

- (bool) tryLock

Tries to lock the lock.

Returns
A boolean whether the lock could be locked
Exceptions
OFLockFailedExceptionThe lock could not be acquired for another reason than it already being held

◆ unlock

- (void) unlock

Unlocks the lock.

Exceptions
OFUnlockFailedExceptionReleasing the lock failed

The documentation for this protocol was generated from the following file: