UT/UT_ThreadSharedLock.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * NAME:        UT_Condition.h ( UT Library, C++)
 *
 * COMMENTS:
 */

#ifndef __UT_ThreadSharedLock_h__
#define __UT_ThreadSharedLock_h__

#include "UT_API.h"
#include "UT_Thread.h"
#include "UT_Lock.h"
#include "UT_Condition.h"

#if defined(USE_BOOST_CONDITIONS)
#include <boost/thread/mutex.hpp>
#include <boost/thread/condition_variable.hpp>
#include <boost/thread/locks.hpp>
#endif

class UT_API UT_ThreadSharedLock
{
public:
    UT_ThreadSharedLock();
    ~UT_ThreadSharedLock();

    // Call this static method to put the current thread in a particular thread
    // group.  By default, each thread will be in its own group, identified by
    // its thread id.  You can, for example, put a thread into the same group
    // as the main thread by setting its group to the main thread's id.
    static void setGroupIdForThisThread(ut_thread_id_t group_id);

    void lock();
    void unlock();

private:
    // Prevent users from calling the copy constructor or assignment operator
    // by declaring them as private.  They are not implemented.
    UT_ThreadSharedLock(const UT_ThreadSharedLock &);
    UT_ThreadSharedLock &operator=(const UT_ThreadSharedLock &);

#if !defined(USE_BOOST_CONDITIONS)
    UT_Lock myCriticalSectionLock;
    UT_Condition myCondition;
#else
    boost::mutex myCriticalSectionLock;
    boost::condition_variable myCondition;
#endif
    int myLockCount;
    ut_thread_id_t myThreadGroupIdWithLock;
    int myNumWaitingThreads;
};

#endif

---