OsMutex.h

Go to the documentation of this file.

//  
// Copyright (C) 2006 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$


#ifndef _OsMutex_h_
#define _OsMutex_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "os/OsDefs.h"
#include "os/OsSyncBase.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS

class OsMutexBase : public OsSyncBase
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

   enum MutexOptions
   {
      Q_FIFO         = 0x0, 
      Q_PRIORITY     = 0x1, 
      DELETE_SAFE    = 0x4, 
      INVERSION_SAFE = 0x8  
   };

/* ============================ CREATORS ================================== */

/* ============================ MANIPULATORS ============================== */

   virtual OsStatus acquire(const OsTime& rTimeout = OsTime::OS_INFINITY) = 0;

   virtual OsStatus tryAcquire(void) = 0;
   virtual OsStatus release(void) = 0;

/* ============================ ACCESSORS ================================= */

   virtual void OsMutexShow(void) = 0;

/* ============================ INQUIRY =================================== */

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
   OsMutexBase() { };

   virtual
   ~OsMutexBase() { };

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

   OsMutexBase(const OsMutexBase& rOsMutexBase);

   OsMutexBase& operator=(const OsMutexBase& rhs);

};

/* ============================ INLINE METHODS ============================ */

#if defined(_WIN32)
#  include "os/Wnt/OsMutexWnt.h"
   typedef class OsMutexWnt OsMutex;
#elif defined(_VXWORKS)
#  include "os/Vxw/OsMutexVxw.h"
   typedef class OsMutexVxw OsMutex;
#elif defined(__pingtel_on_posix__)
#  include "os/linux/OsMutexLinux.h"
   typedef class OsMutexLinux OsMutex;
#else
#  error Unsupported target platform.
#endif

#endif  // _OsMutex_h_