MutexPool.h

Go to the documentation of this file.

/*
   For more information, please see: http://software.sci.utah.edu

   The MIT License

   Copyright (c) 2009 Scientific Computing and Imaging Institute,
   University of Utah.

   
   Permission is hereby granted, free of charge, to any person obtaining a
   copy of this software and associated documentation files (the "Software"),
   to deal in the Software without restriction, including without limitation
   the rights to use, copy, modify, merge, publish, distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included
   in all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   DEALINGS IN THE SOFTWARE.
*/



///
///@file   MutexPool 
///@brief  A set of mutex objects
///
///@author Steve Parker
///        Department of Computer Science
///        University of Utah
///@date   September 1999
///

#ifndef Core_Thread_MutexPool_h
#define Core_Thread_MutexPool_h

#include <vector>
#include <boost/shared_ptr.hpp>
#include <Core/Thread/Legacy/AtomicCounter.h>
#include <Core/Thread/Legacy/Mutex.h>

#include <Core/Thread/Legacy/share.h>

namespace SCIRun {
/**************************************
 
@class
   MutexPool
   
KEYWORDS
   Thread, Mutex
   
@details
   A container class for a set of Mutex objects.  This can be used to
   limit the number of active mutexes down to a more reasonable set.
   However, this must be used very carefully, as it becomes easy to
   create a hold-and-wait condition.
****************************************/
    class SCISHARE MutexPool {
    public:
        //////////
        /// Create the mutex pool with size mutex objects.
        MutexPool(const char* name, int size);

        //////////
        /// Destroy the mutex pool and all mutexes in it.
        ~MutexPool();


        //////////
        /// return the next available mutex
        Mutex &getMutex();

    private:
        //////////
        /// return the next index in a round-robin fashion
        int nextIndex();

        //////////
        /// The next ID
        AtomicCounter nextID_;

        //////////
        /// The number of Mutexes in the pool
        int size_;

        //////////
        /// The array of Mutex objects.
      std::vector<boost::shared_ptr<Mutex> > pool_;

        //////////
        /// Private copy ctor to prevent accidental copying
        MutexPool(const MutexPool&);
        //////////
        /// Private assignment operator to prevent accidental assignment
        MutexPool& operator=(const MutexPool&);
    };
} // End namespace SCIRun

#endif