lock.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef AJA_LOCK_H
#define AJA_LOCK_H
 
#include "ajabase/common/public.h"
#include <assert.h>
#if defined(AJA_USE_CPLUSPLUS11) && !defined(AJA_BAREMETAL)
    #include <mutex>
    #include <string>
#endif
 
#define LOCK_TIME_INFINITE 0xffffffff
 
 
// forward declarations
class AJALockImpl;
 
class AJA_EXPORT AJALock
{
public:
 
    AJALock(const char* pName = NULL);
    virtual ~AJALock();
 
    virtual AJAStatus Lock(uint32_t timeout = LOCK_TIME_INFINITE);
 
    virtual AJAStatus Unlock();
 
    virtual inline bool IsValid(void) const
        {
            #if defined(AJA_USE_CPLUSPLUS11) && !defined(AJA_BAREMETAL)
                return mpMutex != nullptr;
            #else
                return mpImpl != NULL;
            #endif
        }
 
    AJALock (const AJALock & inLock);
    virtual AJALock &   operator = (const AJALock & inLock);
 
private:
#if defined(AJA_USE_CPLUSPLUS11) && !defined(AJA_BAREMETAL)
    std::recursive_timed_mutex* mpMutex={nullptr};
    std::string mName;
#else
    AJALockImpl* mpImpl;
#endif
};
 
class AJA_EXPORT AJAAutoLock
{
public:
 
    AJAAutoLock(AJALock* pLock = NULL);
 
    virtual ~AJAAutoLock();
 
private:
 
    AJALock* mpLock;
};
 
#endif  //  AJA_LOCK_H