vsemaphore.h

Go to the documentation of this file.

/*
Copyright c1997-2014 Trygve Isaacson. All rights reserved.
This file is part of the Code Vault version 4.1
http://www.bombaydigital.com/
License: MIT. See LICENSE.md in the Vault top level directory.
*/

#ifndef vsemaphore_h
#define vsemaphore_h

#include "vthread.h"

class VMutex;

class VSemaphore {
    public:

        VSemaphore();
        virtual ~VSemaphore();

        void wait(VMutex* ownedMutex, const VDuration& timeoutInterval);
        void signal();

        /* PLATFORM-SPECIFIC STATIC FUNCTIONS --------------------------------
        The remaining functions defined here are the low-level interfaces to
        the platform-specific semaphore APIs. These are implemented in each
        platform-specific version of vthread_platform.cpp.
        */

        static bool semaphoreInit(VSemaphore_Type* semaphore);

        static bool semaphoreDestroy(VSemaphore_Type* semaphore);

        static bool semaphoreWait(VSemaphore_Type* semaphore, VMutex_Type* mutex, const VDuration& timeoutInterval);

        static bool semaphoreSignal(VSemaphore_Type* semaphore);

        static bool semaphoreBroadcast(VSemaphore_Type* semaphore);

    private:

        VSemaphore_Type mSemaphore; 
};

#endif /* vsemaphore_h */