MboSynch.h

Go to the documentation of this file.

/*****************************************************************************
* Copyright (c) 2001 - 2008 Marcus Boerger.  All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
* ========================================================================= */

/* ------------------------------------------------------------------------ */
/* Name:      MboSynch.h / MboSynch.cpp
 *
 * Requires:  
 * - Mbo.h
 */
/* ------------------------------------------------------------------------ */

#ifndef _MBOSYNCH_H_
#define _MBOSYNCH_H_

#include "Mbo.h"
#include "MboDebugTrace.h"
#include <assert.h>
#include <vector>

#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable: 4251) // disable warning C4251: '...' : class '...' needs to have dll-interface to be used by clients of class '...'
# pragma warning(disable: 4275) // non dll-interface class '...' used as base for dll-interface class '...'
# pragma warning(disable: 4290) // C++-exception-specification ignored
# ifndef _CPPRTTI
#  error You must compile using RTTI
# endif // _CPPRTTI
#endif // _MSC_VER

namespace mbo
{

// define the time to wait between to Try/Leave cyles in MultiLock::Enter()
#ifndef MBO_MULTI_LOCK_SLEEPTIME
# define MBO_MULTI_LOCK_SLEEPTIME 5
#endif

#if !defined(LONG) && _MSC_VER >= 1300
//# error Wrong includes or macro definitions that control includes
#endif

typedef LONG IncDecVal;  
class CLock; // Forward declaration

/* ------------------------------------------------------------------------ */
class MBO_API ILock // lx
{
public:
    virtual ~ILock() {}

    virtual void Enter() const =0;
    
    virtual void Leave() const =0;

    virtual unsigned long GetLevel() const =0;
};

/* ------------------------------------------------------------------------ */
class MBO_API IEvent // evt
{
public:
    virtual ~IEvent() {}

    virtual void Set() =0;


    virtual void Reset() =0;

    virtual void Pulse() =0;

    virtual bool Wait(_IN size_t nTime = INFINITE) const =0;
};

/* ------------------------------------------------------------------------ */
class MBO_API ICriticalSection // mx
{
public:

    virtual ~ICriticalSection() {}

    virtual void Enter() const =0;

    virtual void Leave() const =0;

    virtual CLock GetLock() const =0;

    virtual unsigned long GetLevel() const =0;
};

/* ------------------------------------------------------------------------ */
class MBO_API IMutex: public ICriticalSection // mx
{
friend class MutexList;  
public:
    virtual void Enter() const { while (!Try(INFINITE)); }
    
    virtual bool Try(_IN DWORD nMilliseconds = 0) const =0;

    virtual CLock GetLock() const =0;

protected:

    virtual HANDLE GetHandle() const { return INVALID_HANDLE_VALUE; }

    virtual IncDecVal IncEntered() const =0;

    virtual IncDecVal DecEntered() const =0;
};

/* ------------------------------------------------------------------------ */
class MBO_API CLockFake: public ILock // lx
{
public:

    inline  CLockFake() {} 
    inline  explicit CLockFake(_IN const ICriticalSection*) {} 
    inline  explicit CLockFake(_IN const ILock&) {} 
    inline virtual void Enter() const {} 
    inline virtual void Leave() const {} 
    inline virtual unsigned long GetLevel() const { return 1; }; 
};

/* ------------------------------------------------------------------------ */
class MBO_API CLockSingle: public ILock // lx
{
friend CLock;
public:

---