blob: 074b36b3b826393fa4f7149c482eec6e685f1698 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*/
/** BEGIN COPYRIGHT BLOCK
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA
*
* Copyright (C) 2007 Red Hat, Inc.
* All rights reserved.
* END COPYRIGHT BLOCK **/
#ifndef __POOL_H__
#define __POOL_H__
#ifdef HAVE_CONFIG_H
#ifndef AUTOTOOLS_CONFIG_H
/* Eliminate warnings when using Autotools */
#undef PACKAGE_BUGREPORT
#undef PACKAGE_NAME
#undef PACKAGE_STRING
#undef PACKAGE_TARNAME
#undef PACKAGE_VERSION
#define AUTOTOOLS_CONFIG_H
#include <config.h>
#endif /* AUTOTOOLS_CONFIG_H */
#endif /* HAVE_CONFIG_H */
/**
* Utility classes for object pools
*
* @author rweltman@netscape.com
* @version 1.0
*/
class PoolNode;
class Pool;
typedef int (*PoolEnumerator)(PoolNode *node);
/**
* A node in a pool
*/
class EXPORT_DECL PoolNode {
friend class Pool;
public:
/**
* Constructor
*
* @param data The real data of the node
*/
PoolNode( void *data );
/**
* Destructor
*/
virtual ~PoolNode();
/**
* Returns the real data of the node
*
* @return The real data of the node
*/
void *GetData();
/**
* Returns the next entry in the list
*
* @return The next entry in the list
*/
PoolNode *GetNext();
/**
* Returns the previous entry in the list
*
* @return The previous entry in the list
*/
PoolNode *GetPrev();
private:
void *m_data;
PoolNode *m_next;
PoolNode *m_prev;
};
/**
* A generic object pool
*/
class EXPORT_DECL Pool {
public:
/**
* Constructor - creates a pool with an internal list of nodes
*
* @param name Name of pool
* @param poolSize Max number of nodes kept
* @param enumerator Optional enumerator to be called on destruction
*/
Pool( const char *name, int poolSize, PoolEnumerator enumerator = NULL );
/**
* Destructor - Empties the pool
*/
virtual ~Pool();
/**
* Appends an entry to the end of the internal list
*
* @param node An entry to add
* @return The added entry
*/
PoolNode *Append( PoolNode *node );
/**
* Retrieves the head of the internal list and removes it
*
* @return The head of the internal list
*/
PoolNode *RemoveHead();
/**
* Returns true if the pool is empty
*
* @return true if the pool is empty
*/
bool IsEmpty();
/**
* Returns the number of entries in the pool
*
* @return The number of entries in the pool
*/
int GetCount();
protected:
private:
PoolNode *m_list;
char *m_name;
int m_maxNodes;
int m_count;
PoolEnumerator m_enumerator;
PRRWLock *m_lock;
PRLock *m_conditionLock;
PRCondVar *m_condition;
};
#endif // __POOL_H__
|
