SbThreadRWMutex.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-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Julien Chaplier (MMM yyyy)
**=======================================================================*/
 
#ifndef _SB_THREAD_RW_MUTEX_H_
#define _SB_THREAD_RW_MUTEX_H_
 
#if defined(_WIN32)
#pragma warning( push )
#pragma warning( disable: 4251 ) // 'identifier' : class 'type' needs to have dll-interface to be used by clients of class 'type2'
#endif
 
#include <Inventor/SbBase.h>
#include <Inventor/SbPImpl.h>
 
// keep this header for compatibility purpose
#include <Inventor/threads/SbThread.h>
#include <Inventor/threads/SbThreadSpinlock.h>
#include <Inventor/threads/SbThreadAutoLock.h>
 
SO_PIMPL_BASE_PUBLIC_DECLARATION(SbThreadRWMutex)
 
 
class  SbThreadRWMutex
{
  SO_PIMPL_BASE_PUBLIC_HEADER( SbThreadRWMutex );
 
 public:
  SbThreadRWMutex();
 
#if 1             SoDEPRECATED
  SbThreadRWMutex( const SbBool force );
#endif 
  ~SbThreadRWMutex();
 
  int writelock();
 
  int writeunlock();
 
  int readlock();
 
  int readunlock();
 
private:
 
  // returns if someone has a lock on this mutex (even current thread)
  // it is particularly usefull to check if the mutex can be deleted or not.
  SbBool isUsed() const;
 
  // version adapted for r/w try-locking. It is a little slower
  // than the regular trylock. Synonymous for trywritelock. No
  // trylock should be done within a readlock on the same mutex.
  // !!! Not fully implemented
  SbBool trywritelock();
 
  // Equivalent to readlock but does not block if the reader cannot
  // lock the mutex and returns FALSE. Otherwise returns TRUE.
  // !!! Not fully implemented
  SbBool tryreadlock();
 
private:
  // no copy constructor
  SbThreadRWMutex(const SbThreadRWMutex&);
};
 
#if defined(_WIN32)
#pragma warning( pop )
#endif
 
#endif //_SB_THREAD_RW_MUTEX_H_