libcommonc++  0.7
ObjectPool.h++
Go to the documentation of this file.
1 /* ---------------------------------------------------------------------------
2  commonc++ - A C++ Common Class Library
3  Copyright (C) 2005-2014 Mark A Lindner
4 
5  This file is part of commonc++.
6 
7  This library is free software; you can redistribute it and/or
8  modify it under the terms of the GNU Library General Public
9  License as published by the Free Software Foundation; either
10  version 2 of the License, or (at your option) any later version.
11 
12  This library is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  Library General Public License for more details.
16 
17  You should have received a copy of the GNU Library General Public
18  License along with this library; if not, write to the Free
19  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20  ---------------------------------------------------------------------------
21 */
22 
23 #ifndef __ccxx_ObjectPool_hxx
24 #define __ccxx_ObjectPool_hxx
25 
26 #include <commonc++/Common.h++>
27 #include <commonc++/Exception.h++>
28 
29 namespace ccxx {
30 
37 {
38  public:
39 
42  : Exception(message)
43  { }
44 
45  inline void write(std::ostream& stream) const
46  { _write(stream, "ObjectPoolException"); }
47 };
48 
56 template <typename T> class ObjectPool
57 {
58  public:
59 
66  : _size(size),
67  _avail(size)
68  { }
69 
71  virtual ~ObjectPool()
72  { }
73 
80  virtual T* reserve() = 0;
81 
89  virtual void release(T* elem) = 0;
90 
95  inline uint_t getSize() const
96  { return(_size); }
97 
99  inline uint_t getAvailable() const
100  { return(_avail); }
101 
102  protected:
103 
109 
112 };
113 
114 } // namespace ccxx
115 
116 #endif // __ccxx_ObjectPool_hxx
A base class for object pools.
Definition: ObjectPool.h++:56
uint_t getSize() const
Get the size of the pool, i.e., the total number of objects (both reserved and available) in the pool...
Definition: ObjectPool.h++:95
uint_t getAvailable() const
Get the number of available (unreserved) objects in the pool.
Definition: ObjectPool.h++:99
static const String empty
The empty string.
Definition: String.h++:1134
void write(std::ostream &stream) const
Write a textual representation of the exception to a stream.
Definition: ObjectPool.h++:45
uint_t _avail
The number of objects currently available (not reserved) in the pool.
Definition: ObjectPool.h++:111
ObjectPool(uint_t size)
Constructor.
Definition: ObjectPool.h++:65
unsigned int uint_t
An alias for unsigned int.
Definition: Integers.h++:74
ObjectPoolException(String message=String::empty)
Construct a new ObjectPoolException with an optional cause message.
Definition: ObjectPool.h++:41
virtual ~ObjectPool()
Destructor.
Definition: ObjectPool.h++:71
uint_t _size
The size of the pool (i.e., the maximum number of objects managed by the pool).
Definition: ObjectPool.h++:108
#define COMMONCPP_API
Definition: Common.h++:126
A flexible, reference counted, copy-on-write, thread-safe, nullable string.
Definition: String.h++:50
An exception indicating an ObjectPool error.
Definition: ObjectPool.h++:36
Definition: AllocationMap.c++:25
A general-purpose exception.
Definition: Exception.h++:39