ObjectPool.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

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

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_ObjectPool_hxx
#define __ccxx_ObjectPool_hxx

#include <commonc++/Common.h++>
#include <commonc++/Exception.h++>

namespace ccxx {

class COMMONCPP_API ObjectPoolException : public Exception
{
  public:

  ObjectPoolException(String message = String::empty)
    : Exception(message)
  {
  }

  inline void write(std::ostream& stream) const
  { _write(stream, "ObjectPoolException"); }
};

template <typename T> class ObjectPool
{
  public:

  ObjectPool(size_t size)
    : _size(size), _avail(size)
  {
  }

  virtual ~ObjectPool() throw()
  {
  }

  virtual T *reserve() throw(ObjectPoolException) = 0;

  virtual void release(T *elem) throw(ObjectPoolException) = 0;

  inline size_t getSize() const throw()
  { return(_size); }

  inline uint_t getAvailable() const throw()
  { return(_avail); }

  protected:

  size_t _size;

  uint_t _avail;
};

}; // namespace ccxx

#endif // __ccxx_ObjectPool_hxx

/* end of header file */