SbThreadAutoLock.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : David Beilloin (Feb 2008)
**=======================================================================*/
 
#ifndef _SB_THREAD_AUTO_LOCK_H_
#define _SB_THREAD_AUTO_LOCK_H_
 
#include <Inventor/SbBase.h>
#include <Inventor/threads/SbThreadMutex.h>
 
class SbThreadRWMutex;
 
class  SbThreadAutoLock {
 public:
  SbThreadAutoLock(SbThreadMutex *mutex)
  {
    m_mutex = mutex;
    if ( m_mutex )
      m_mutex->lock();
  }
 
  SbThreadAutoLock( SbThreadMutex &mutex )
  {
    m_mutex = &mutex;
    m_mutex->lock();
  }
 
#ifndef HIDDEN_FROM_DOC
  ~SbThreadAutoLock()
  {
    if ( m_mutex )
      m_mutex->unlock();
  }
#endif // HIDDEN_FROM_DOC
 
 private:
  SbThreadMutex *m_mutex;
};
 
class  SbThreadAutoReadLock {
 public:
  SbThreadAutoReadLock( SbThreadRWMutex *mutex );
  SbThreadAutoReadLock( SbThreadRWMutex &mutex );
 
#ifndef HIDDEN_FROM_DOC
  ~SbThreadAutoReadLock();
#endif
 
  int unlock();
  int relock();
 
 private:
  SbThreadRWMutex *m_mutex;
  SbBool           m_isLocked;
 
};
 
class  SbThreadAutoWriteLock {
 public:
  SbThreadAutoWriteLock( SbThreadRWMutex *mutex );
  SbThreadAutoWriteLock( SbThreadRWMutex &mutex );
 
#ifndef HIDDEN_FROM_DOC
  ~SbThreadAutoWriteLock();
#endif
 
  int unlock();
  int relock();
 
 private:
  SbThreadRWMutex *m_mutex;
  SbBool           m_isLocked;
 
};
 
#endif //_SB_THREAD_AUTO_LOCK_H_