ObjFW
Instance Methods | 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.
 
(bool) - tryLock
 Tries to lock the lock. More...
 
(void) - unlock
 Unlocks the lock.
 
(void) - setName:
 Sets a name for the lock. More...
 
(nullable OFString *) - name
 Returns the name for the lock. More...
 
- Instance Methods inherited from <OFObject>
(Class) - class
 Returns the class of the object. More...
 
(Class) - superclass
 Returns the superclass of the object. More...
 
(bool) - isKindOfClass:
 Returns a boolean whether the object 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 const char *) - typeEncodingForSelector:
 Returns the type encoding 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...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(uint32_t) - hash
 Calculates a hash for the object. More...
 
(id) - retain
 Increases the retain count. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(id) - autorelease
 Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...
 
(id) - self
 Returns the receiver. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 

Detailed Description

A protocol for locks.

Method Documentation

- (nullable OFString*) name

Returns the name for the lock.

Returns
The name for the lock
- (void) setName: (nullable OFString *)  name

Sets a name for the lock.

Parameters
nameThe name for the lock
- (bool) tryLock

Tries to lock the lock.

Returns
A boolean whether the lock could be locked

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