ofxsMultiThread.h

Go to the documentation of this file.

#ifndef _ofxsMultiThread_H_
#define _ofxsMultiThread_H_
/*
OFX Support Library, a library that skins the OFX plug-in API with C++ classes.
Copyright (C) 2004-2007 The Foundry Visionmongers Ltd
Author Bruno Nicoletti bruno@thefoundry.co.uk

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name The Foundry Visionmongers Ltd, nor the names of its 
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The Foundry Visionmongers Ltd
1 Wardour St
London W1D 6PA
England



*/

#include "ofxsCore.h"

typedef struct OfxMutex* OfxMutexHandle;

namespace OFX {

  namespace MultiThread {

    class Processor {
    private :
      static void staticMultiThreadFunction(unsigned int threadIndex, unsigned int threadMax, void *customArg);

    public  :
      Processor();

      virtual ~Processor();            

      virtual void multiThreadFunction(unsigned int threadID, unsigned int nThreads) = 0;

      virtual void multiThread(unsigned int nCPUs = 0);
    };

    bool isSpawnedThread(void);

    unsigned int getNumCPUs(void);

    unsigned int getThreadIndex(void);

    class Mutex {
    protected :
      OfxMutexHandle _handle; 
    public :
      Mutex(int lockCount = 0);

      virtual ~Mutex(void);

      void lock();

      void unlock();

      bool tryLock();
    };

    class AutoMutex {
    protected :
      Mutex &_mutex;

    public :
      explicit AutoMutex(Mutex &m)
        : _mutex(m)
      {
        _mutex.lock();
      }

      virtual ~AutoMutex()
      {
        _mutex.unlock();
      }

    };
  };
};

#endif

---