ObjFW
OFLocking.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
3  * Jonathan Schleifer <js@webkeks.org>
4  *
5  * All rights reserved.
6  *
7  * This file is part of ObjFW. It may be distributed under the terms of the
8  * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
9  * the packaging of this file.
10  *
11  * Alternatively, it may be distributed under the terms of the GNU General
12  * Public License, either version 2 or 3, which can be found in the file
13  * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
14  * file.
15  */
16 
17 #import "OFObject.h"
18 
19 OF_ASSUME_NONNULL_BEGIN
20 
26 @protocol OFLocking <OFObject>
27 #ifdef OF_HAVE_PROPERTIES
28 @property OF_NULLABLE_PROPERTY (copy) OFString *name;
29 #endif
30 
34 - (void)lock;
35 
41 - (bool)tryLock;
42 
46 - (void)unlock;
47 
53 - (void)setName: (nullable OFString*)name;
54 
60 - (nullable OFString*)name;
61 @end
62 
63 OF_ASSUME_NONNULL_END
A protocol for locks.
Definition: OFLocking.h:26
The root class for all other classes inside ObjFW.
Definition: OFObject.h:364
void unlock()
Unlocks the lock.
A class for handling strings.
Definition: OFString.h:91
bool tryLock()
Tries to lock the lock.
nullable OFString * name()
Returns the name for the lock.
void lock()
Locks the lock.