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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
/* -*- C++ -*- */
// $Id$
// ============================================================================
//
// = LIBRARY
// ace
//
// = FILENAME
// Caching_Utility_T.h
//
// = AUTHOR
// Kirthika Parameswaran <kirthika@cs.wustl.edu>
//
// ============================================================================
#ifndef CACHING_UTILITY_H
#define CACHING_UTILITY_H
#include "ace/OS.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
#define ACE_LACKS_PRAGMA_ONCE
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/Cleanup_Strategies_T.h"
template <class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
class ACE_Pair_Caching_Utility
{
// = TITLE
// Defines a helper class for the Caching Strategies.
//
// = DESCRIPTION
// This class defines the methods commonly used by the different
// caching strategies. For instance: <clear_cache> method which
// decides and purges the entry from the container. Note: This
// class helps in the caching_strategies using a container
// containing entries of <KEY, ACE_Pair<VALUE, attributes>>
// kind. The attributes helps in deciding the entries to be
// purged. The Cleanup_Strategy is the callback class to which the
// entries to be cleaned up will be delegated.
public:
typedef ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY;
ACE_Pair_Caching_Utility (ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> *cleanup_strategy = 0,
int delete_cleanup_strategy = 0);
// Constructor.
~ACE_Pair_Caching_Utility (void);
// Destructor.
int clear_cache (CONTAINER &container,
double purge_percent);
// Purge entries from the <container>. The Cleanup_Strategy will do
// the actual job of cleanup once the entries to be cleaned up are
// decided.
protected:
void minimum (CONTAINER &container,
KEY *&key_to_remove,
VALUE *&value_to_remove);
// Find the entry with minimum caching attributes.
CLEANUP_STRATEGY *cleanup_strategy_;
// The cleanup strategy which can be used to destroy the entries of
// the container.
int delete_cleanup_strategy_;
// Whether the cleanup_strategy should be destroyed or not.
};
////////////////////////////////////////////////////////////////////////////////
template <class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
class ACE_Recyclable_Handler_Caching_Utility
{
// = TITLE
// Defines a helper class for the Caching Strategies.
//
// = DESCRIPTION
// This class defines the methods commonly used by the different
// caching strategies. For instance: <clear_cache> method which
// decides and purges the entry from the container. Note: This
// class helps in the caching_strategies using a container
// containing entries of <KEY, Svc_Handler> kind. The attributes
// helps in deciding the entries to be purged. The
// Cleanup_Strategy is the callback class to which the entries to
// be cleaned up will be delegated.
public:
typedef ACE_Recyclable_Handler_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY;
typedef ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY_BASE;
ACE_Recyclable_Handler_Caching_Utility (ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> *cleanup_strategy = 0,
int delete_cleanup_strategy = 0);
// Constructor.
~ACE_Recyclable_Handler_Caching_Utility (void);
// Destructor.
int clear_cache (CONTAINER &container,
double purge_percent);
// Purge entries from the <container>. The Cleanup_Strategy will do
// the actual job of cleanup once the entries to be cleaned up are
// decided.
protected:
void minimum (CONTAINER &container,
KEY *&key_to_remove,
VALUE *&value_to_remove);
// Find the entry with minimum caching attributes.
CLEANUP_STRATEGY_BASE *cleanup_strategy_;
// This is the default Cleanup Strategy for this utility.
int delete_cleanup_strategy_;
// Whether the cleanup_strategy should be destroyed or not.
};
////////////////////////////////////////////////////////////////////////////////////////
template <class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
class ACE_Handler_Caching_Utility
{
// = TITLE
// Defines a helper class for the Caching Strategies.
//
// = DESCRIPTION
// This class defines the methods commonly used by the different
// caching strategies. For instance: <clear_cache> method which
// decides and purges the entry from the container. Note: This
// class helps in the caching_strategies using a container
// containing entries of <KEY, HANDLER> kind where the HANDLER
// contains the caching attributes which help in deciding the
// entries to be purged. The Cleanup_Strategy is the callback
// class to which the entries to be cleaned up will be delegated.
public:
typedef ACE_Handler_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY;
typedef ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY_BASE;
ACE_Handler_Caching_Utility (ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> *cleanup_strategy = 0,
int delete_cleanup_strategy = 0);
// Constructor.
~ACE_Handler_Caching_Utility (void);
// Destructor.
int clear_cache (CONTAINER &container,
double purge_percent);
// Purge entries from the <container>. The Cleanup_Strategy will do
// the actual job of cleanup once the entries to be cleaned up are
// decided.
protected:
void minimum (CONTAINER &container,
KEY *&key_to_remove,
VALUE *&value_to_remove);
// Find the entry with minimum caching attributes. This is handler
// specific since this utility is to be used very specifically for
// handler who have caching_attributes for server side acched
// connection management.
CLEANUP_STRATEGY_BASE *cleanup_strategy_;
// The cleanup strategy which can be used to destroy the entries of
// the container.
int delete_cleanup_strategy_;
// Whether the cleanup_strategy should be destroyed or not.
};
///////////////////////////////////////////////////////////////////////////
template <class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
class ACE_Null_Caching_Utility
{
// = TITLE
// Defines a dummy helper class for the Caching Strategies.
//
// = DESCRIPTION
// This class defines the methods commonly used by the different
// caching strategies. For instance: <clear_cache> method which
// decides and purges the entry from the container. Note: This
// class is be used with the Null_Caching_Strategy. The
// Cleanup_Strategy is the callback class to which the entries to
// be cleaned up will be delegated.
public:
typedef ACE_Null_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY;
typedef ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> CLEANUP_STRATEGY_BASE;
ACE_Null_Caching_Utility (ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> *cleanup_strategy = 0,
int delete_cleanup_strategy = 0);
// Constructor.
~ACE_Null_Caching_Utility (void);
// Destructor.
int clear_cache (CONTAINER &container,
double purge_percent);
// Purge entries from the <container>. The Cleanup_Strategy will do
// the actual job of cleanup once the entries to be cleaned up are
// decided. NOte: Here it is a no-op.
protected:
void minimum (CONTAINER &container,
KEY *&key_to_remove,
VALUE *&value_to_remove);
// Find the entry with minimum caching attributes. This is handler
// specific since this utility is to be used very specifically for
// handler who have caching_attributes for server side acched
// connection management.Note: Here it is a no-op.
CLEANUP_STRATEGY_BASE *cleanup_strategy_;
// The cleanup strategy which can be used to destroy the entries of
// the container.
int delete_cleanup_strategy_;
// Whether the cleanup_strategy should be destroyed or not.
};
///////////////////////////////////////////////////////////////////////////
#if defined (__ACE_INLINE__)
#include "ace/Caching_Utility_T.i"
#endif /* __ACE_INLINE__ */
#if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
#include "ace/Caching_Utility_T.cpp"
#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */
#if defined (ACE_TEMPLATES_REQUIRE_PRAGMA)
#pragma implementation ("Caching_Utility_T.cpp")
#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */
#endif /* CACHING_UTILITY_H */
|
