/*
* Copyright (c) 2008-2024 Jonathan Schleifer <js@nil.im>
*
* All rights reserved.
*
* This file is part of ObjFW. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE.QPL included in
* the packaging of this file.
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/
#import "OFObject.h"
#import "OFLocking.h"
#import "OFPlainMutex.h"
OF_ASSUME_NONNULL_BEGIN
/**
* @class OFMutex OFMutex.h ObjFW/OFMutex.h
*
* @brief A class for creating mutual exclusions.
*
* If the mutex is deallocated while being held, it throws an
* @ref OFStillLockedException. While this might break ARC's assumption that no
* object ever throws in dealloc, it is considered a fatal programmer error
* that should terminate the application.
*/
@interface OFMutex: OFObject <OFLocking>
{
OFPlainMutex _mutex;
bool _initialized;
OFString *_Nullable _name;
OF_RESERVE_IVARS(OFMutex, 4)
}
/**
* @brief Creates a new mutex.
*
* @return A new autoreleased mutex.
*/
+ (instancetype)mutex;
@end
OF_ASSUME_NONNULL_END