LockGuard.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef YARP_OS_LOCKGUARD_H
#define YARP_OS_LOCKGUARD_H
 
#include <yarp/conf/system.h>
 
#if !defined(YARP_INCLUDING_DEPRECATED_HEADER_ON_PURPOSE)
YARP_COMPILER_WARNING("<yarp/os/LockGuard.h> file is deprecated")
#endif
 
#ifndef YARP_NO_DEPRECATED // since YARP 3.3
 
#include <yarp/os/api.h>
#include <mutex>
 
namespace yarp::os {
 
class Mutex;
class RecursiveMutex;
 
template <typename Lockable>
class YARP_DEPRECATED_MSG("Use std::lock_guard or std::scoped_lock instead") AbstractLockGuard
{
public:
    explicit AbstractLockGuard(Lockable& _lock);
 
    ~AbstractLockGuard();
 
private:
    AbstractLockGuard(const AbstractLockGuard&);
 
    AbstractLockGuard& operator=(const AbstractLockGuard&);
 
    Lockable& lock; 
};
 
// Implementation
 
YARP_WARNING_PUSH
YARP_DISABLE_DEPRECATED_WARNING
 
template <typename Lockable>
yarp::os::AbstractLockGuard<Lockable>::AbstractLockGuard(Lockable& _lock) :
        lock(_lock)
{
    lock.lock();
}
 
template <typename Lockable>
yarp::os::AbstractLockGuard<Lockable>::~AbstractLockGuard()
{
    lock.unlock();
}
 
template <typename Lockable>
yarp::os::AbstractLockGuard<Lockable>::AbstractLockGuard(const AbstractLockGuard& lg) :
        lock(lg.lock)
{
}
 
template <typename Lockable>
yarp::os::AbstractLockGuard<Lockable>& yarp::os::AbstractLockGuard<Lockable>::operator=(const AbstractLockGuard&)
{
    return *this;
}
 
YARP_DEPRECATED_TYPEDEF_MSG("use std::lock_guard or std::scoped_lock instead") AbstractLockGuard<Mutex> LockGuard;
YARP_DEPRECATED_TYPEDEF_MSG("use std::lock_guard or std::scoped_lock instead") AbstractLockGuard<RecursiveMutex> RecursiveLockGuard;
 
YARP_WARNING_POP
 
} // namespace yarp::os
 
#endif // YARP_NO_DEPRECATED
 
#endif // YARP_OS_LOCKGUARD_H