summaryrefslogtreecommitdiff
path: root/ace/Caching_Utility_T.h
blob: 542aabff285a2582f68f09024a5caf26fd4207d7 (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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/* -*- 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 */

// Forward declaration
template <class KEY, class VALUE, class CONTAINER>
class ACE_Cleanup_Strategy;

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.
public:

  int clear_cache (CONTAINER &container,
                   ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> *cleanup_s,
                   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:

  virtual void minimum (CONTAINER &container,
                        KEY *&key_to_remove,
                        VALUE *&value_to_remove);
  // Find the entry with minimum caching attributes.
};

////////////////////////////////////////////////////////////////////////////////

template <class KEY, class VALUE, class CONTAINER, class ITERATOR, class ATTRIBUTES>
class ACE_Recyclable_Handler_Caching_Utility : public ACE_Pair_Caching_Utility<KEY, VALUE, CONTAINER, ITERATOR, ATTRIBUTES>
{
  // = 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.
protected:

  virtual void minimum (CONTAINER &container,
                        KEY *&key_to_remove,
                        VALUE *&value_to_remove);
  // Find the entry with minimum caching attributes.
};

////////////////////////////////////////////////////////////////////////////////////////

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.
public:

  int clear_cache (CONTAINER &container,
                   ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> *cleanup_s,
                   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:

  virtual 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.
};

///////////////////////////////////////////////////////////////////////////

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.
public:

  int clear_cache (CONTAINER &container,
                   ACE_Cleanup_Strategy<KEY, VALUE, CONTAINER> *cleanup_s,
                   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:

  virtual 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.
};

///////////////////////////////////////////////////////////////////////////

#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 */