OsLock.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2021 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 _OsLock_h_
#define _OsLock_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include <os/OsSyncBase.h>

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

class OsLock
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:
    typedef enum TakeStateEnum
    {
        Unknown,
        PreAcquire,
        PostAcquire,
        PostRelease
    } OsLockTakeState;
/* ============================ CREATORS ================================== */

   OsLock(OsSyncBase& rSemaphore, void (*lockStateCallback)(OsLockTakeState state, void* data) = NULL, void* callbackData = NULL)
   : mrSemaphore(rSemaphore),
     mStateCallback(lockStateCallback),
     mCallbackData(callbackData)
   {
      if (mStateCallback) mStateCallback(PreAcquire, mCallbackData);
      rSemaphore.acquire();
      if (mStateCallback) mStateCallback(PostAcquire, mCallbackData);
   };

   virtual
   ~OsLock()  
   {
      mrSemaphore.release();
      if (mStateCallback) mStateCallback(PostRelease, mCallbackData);
   };

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

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

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

/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   OsSyncBase& mrSemaphore;

   OsLock();

   OsLock(const OsLock& rOsLock);

   OsLock& operator=(const OsLock& rhs);

   void (*mStateCallback)(OsLockTakeState state, void* data);
   void* mCallbackData;
};

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

#endif  // _OsLock_h_