SyncObj.h

Go to the documentation of this file.

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Project: uLib - User mode library.
// Module: Class wraps for standard IPC sychronization objects.
// Author: Copyright (c) Love Nystrom
// License: NNOSL (BSD descendant, see NNOSL.txt in the base directory).
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#if 1//def __cplusplus // Nothing in here is accessible in C

#ifndef __uLib_Sync_h_incl__
#define __uLib_Sync_h_incl__

#include <uLib/UtilFunc.h>

//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
//~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

typedef class TCritSec *    PCritSec;
typedef class TSyncObj *    PSyncObj;
typedef class TEvent *      PEvent;
typedef class TMutex *      PMutex;
typedef class TSemaphore *  PSemaphore;
typedef class TWaitTimer *  PWaitTimer;

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

class TCritSec {
private: // Unaccessible, so nobody can call them. (They are illegal for CRITICAL_SECTION).
    TCritSec( const TCritSec& src ) { __debugbreak(); } 
    TCritSec& operator = ( const TCritSec& src ) { __debugbreak(); return *this; } 
protected:
    CRITICAL_SECTION _cSec;
public:
    TCritSec();
    TCritSec( DWORD SpinCount ); 
    ~TCritSec();

    DWORD SetSpinCount( DWORD SpinCount ); 
    void  Enter();      
    bool  TryEnter();   
    void  Leave();      
};

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

class TSyncObj {
private: // Unaccessible, so nobody can call them (they would clobber _hSync if implemented).
    TSyncObj& operator = ( const TSyncObj& Src ) { __debugbreak(); return *this; } 
    HANDLE&   operator = ( HANDLE& Src ) { __debugbreak(); return _hSync; } 
protected:
    HANDLE  _hSync;
public:
    TSyncObj();
    TSyncObj( const HANDLE& Src );
    ~TSyncObj();

    bool Close();

    bool Wait( DWORD msWait ); 
    bool WaitEx( DWORD msWait, bool Alertable ); 
    bool SignalAndWait( HANDLE hWaitFor, DWORD msWait, bool Alertable ); 


    HANDLE RegisterWait( WAITORTIMERCALLBACK Callback, PVOID Context, DWORD msWait, DWORD Flags );
    bool UnregisterWait( HANDLE hWait ); 

    operator HANDLE() { return _hSync; }
    HANDLE GetHandle() { return _hSync; }
    bool Initialized() { return (_hSync != NULL); }


    HANDLE Duplicate(
        HANDLE TargetProc, bool Inherit, ACCESS_MASK Access=0, DWORD Opt = DUPLICATE_SAME_ACCESS
        );
};

#ifdef __GNUC__
#pragma GCC diagnostics pop
#endif

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

class TEvent : public TSyncObj {
public:
    TEvent( LPSECURITY_ATTRIBUTES SecAttr, bool Manual, bool Init, CSTR Name = NULL );
    TEvent( DWORD Access, bool Inherit, CSTR Name ); 
    ~TEvent();

    bool Set();   
    bool Reset(); 
    bool Pulse(); 
};

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

class TMutex : public TSyncObj {
public:
    TMutex( LPSECURITY_ATTRIBUTES SecAttr, bool Own, CSTR Name = NULL );
    TMutex( DWORD Access, bool Inherit, CSTR Name ); 
    ~TMutex();

    bool Release(); 
};

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

class TSemaphore : public TSyncObj {
public:
    TSemaphore( LPSECURITY_ATTRIBUTES SecAttr, LONG Count, LONG MaxCount, CSTR Name = NULL );
    TSemaphore( DWORD Access, bool Inherit, CSTR Name ); 
    ~TSemaphore();

    bool Release( LONG Count, OPTOUT LPLONG OldCount = NULL ); 

    // Add some extra functionality to the standard semaphores.

    LONG ReleaseAll(); 
    LONG Lock(); 
};

//==---------------------------------------------------------------------------
//==---------------------------------------------------------------------------

class TWaitTimer : public TSyncObj {
public:
    TWaitTimer( LPSECURITY_ATTRIBUTES SecAttr, bool Manual, CSTR Name = NULL );

    TWaitTimer( DWORD Access, bool Inherit, CSTR Name );

    ~TWaitTimer();


    bool Set( FILETIME Due, LONG Period, PTIMERAPCROUTINE Action, PVOID Context, bool Resume );


    bool Set( INT64 Due, LONG Period, PTIMERAPCROUTINE Action, PVOID Context, bool Resume );

    bool Cancel(); 
};

//==---------------------------------------------------------------------------
#endif//ndef __uLib_Sync_h_incl__
#endif//def __cplusplus
// EOF