ResourcePool.hh

//********************************************************************
//*** ResourcePool/ResourcePool.hh
//*** Copyright (c) 2003-2009 by Markus Winand <mws@fatalmind.com>
//*** $Id: ResourcePool.hh,v 1.49 2009-03-18 14:16:10 mws Exp $
//********************************************************************
/*
This file is part of ResourcePool.

ResourcePool is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2 of 
the License, or (at your option) any later version.

ResourcePool 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with ResourcePool; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307  USA */

#ifndef RESOURCEPOOL_RESOURCEPOOL_HH
#define RESOURCEPOOL_RESOURCEPOOL_HH

#ifndef INCLUDED_GC_PTR_HH
#include "mm/gc_ptr.hh"
#endif

#ifndef MM_REFWRAP_HH
#include "mm/RefWrap.hh"
#endif

#ifndef RESOURCEPOOL_RESOURCEPOOLOPTIONS_HH
#include "ResourcePoolOptions.hh"
#endif
#include "ResourcePoolInterface.hh"

#ifndef INCLUDED_THREAD_LOCK_HH
#include "Thread/Lock.hh"
#endif

#ifndef INCLUDED_THREAD_SYNCHRONIZE_HH
#include "Thread/Synchronize.hh"
#endif

#ifndef INCLUDED_CONDVAR_H
#include "Thread/CondVar.hh"
#endif

#ifndef RESOURCEPOOL_CREATEEXCEPTION_HH
#include "CreateException.hh"
#endif

#include "ResourcePoolType.hh"
#include "ResourcePoolStats.hh"
#include "ResourcePoolEventObserver.hh"


#include <deque>
#include <set>
#include <map>

namespace fatalmind {

template<class T> class Command; // Fwd decl

template<class Type> /* PoolType */
class ResourcePool: public ResourcePoolInterface<Type> {
    public:
        ResourcePool(const typename Type::factory_t&
            , const ResourcePoolOptions& o = ResourcePoolOptions::defaultOptions
        );

        virtual ~ResourcePool();

        virtual typename Type::resource_t& get();
        virtual bool free(typename Type::resource_t&);
        virtual bool fail(typename Type::resource_t&);

        virtual void downsize();

        ResourcePoolStats getStats() const; 

        typedef Type PoolType;

        typedef typename Type::factory_t Factory;

        inline const Factory& getFactory() const {
            return _factory;
        };
        

        inline ResourcePoolEventObserver::event_t setLogEvents(ResourcePoolEventObserver::event_t events) {
            return observer->setLogEvents(events);
        }

        virtual void execute(Command<Type>&);

    protected:
        //*** commonly used typedefs
        typedef typename Type::ThreadingModell TM;
        typedef typename TM::FastCondVar condvar_t;
        typedef Synchronize<condvar_t> sync_t;

        typedef gc_ptr<typename Type::resource_t, TM> resource_ptr;
        typedef std::deque<resource_ptr> freePool_t;

        typedef RefWrap<typename Type::resource_t> plainresource_ptr;
        typedef std::map<plainresource_ptr, resource_ptr> usedPool_t;

    private:
        //*** member variables
        const typename Type::factory_t _factory;
        const ResourcePoolOptions _options;     

        freePool_t _freePool;
        usedPool_t _usedPool;

        mutable condvar_t _condvar;

        bool _stopped;

        ResourcePoolStats _stats;

        const gc_ptr<ResourcePoolEventObserver> observer;

    public:
        typedef typename Type::command_t Commands;

    protected:
        //*** non public member functions
        void sleepit(int tryno) const;
        typename Type::resource_t* moveToUsed();

        // virtual, since execute needs it.
        virtual const ResourcePoolOptions& getOptions() {
            return _options;
        };

    
        inline void _downsize();
        inline void _inc_pool();

        void _waitForFree(const CreateException&, const SingleThreadedModel<>::Type);
        void _waitForFree(const CreateException&, const MultiThreadedModel<>::Type);

    friend
        class fatalmind::Command<Type>;
//  friend not yet
//      std::ostream& operator<< <>(std::ostream&, const ResourcePool<Type>&);  
    private:
        //*** hidden stuff
        ResourcePool(const ResourcePool<Type>&);
        ResourcePool<Type>& operator=(const ResourcePool<Type>&);

        inline void event(int event, const std::string& resourceID = ResourcePoolEventObserver::NoResourceID, const std::string& message = "N/A") {
            observer->event(event, resourceID, message);
        }
};


} // namespace fatalmind
#endif

---