osaMutex.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s): Anton Deguet
  Created on: 2008-01-30

  (C) Copyright 2004-2012 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/


#ifndef _osaMutex_h
#define _osaMutex_h

#include <cisstCommon/cmnPortability.h>
#include <cisstOSAbstraction/osaThread.h>
#include <cisstOSAbstraction/osaExport.h>

struct osaMutexInternals;

class CISST_EXPORT osaMutex {

    osaMutexInternals * Internals;

    osaThreadId LockerId;

    bool Locked;

public:
    /* Enum type representing a timeout period of infinity and no wait. */
    enum TimeoutType {
        WAIT_FOREVER = -1, 
        NO_WAIT = 0        
    };

#if 0 // MJ: obsoleted
    enum ReturnType {
        LOCK_FAILED, 
        SUCCESS,     
        TIMED_OUT    
    };
#endif

    enum LockStateType {
        LOCKED,
        UNLOCKED
    };

    osaMutex(void);

    ~osaMutex(void);

    void Lock(void);

    void Unlock(void);

    //ReturnType TryLock(int timeout);

    bool IsLocker(void) const;

    LockStateType GetLockState(void) const;
};


#endif // _osaMutex_h