CascadeMutex.h

Go to the documentation of this file.

//
// CascadeMutex.h - header file for class CascadeMutex
//
// Copyright (c) 2002, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_INTERTHREAD_CASCADEMUTEX_H
#define _ROKU_INCLUDE_CASCADE_INTERTHREAD_CASCADEMUTEX_H

#include <cascade/CascadeObject.h>

class CascadeMutex : public CascadeObject
{
public:
        CascadeMutex();
        virtual ~CascadeMutex();
public:
        void Lock();
        // Call %Lock() to lock the mutex.  If the mutex is locked by another thread
        // the calling thread will block until the mutex is locked.
        // %Locks() can be nested.
        // @note Only use %CascadeMutex for mutual exclusion on threads.
        // For mutual exclusion on processes, use %CascadeSemLock instead.
        bool TryLock();
        void Unlock();
private:
    class Mutex;
        Mutex * m_pMutex;
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_INTERTHREAD_CASCADEMUTEX_H

//  LOG
//  20-Dec-02   dwoodward       created
//  20-Jan-03   dwoodward       1.0 STATUS: 100% complete
//  05-May-03   dwoodward   doxygenated
//  15-Mar-04   dwoodward   use private nested forward declared class instead of void *
//                          for private impl

---