File: Poco.UniqueAccessExpireStrategy.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (128 lines) | stat: -rw-r--r-- 8,878 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::UniqueAccessExpireStrategy</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1>
<h1 class="template">template &lt; class TKey, class TValue &gt;</h1>
<h1 class="symbol">class UniqueAccessExpireStrategy</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Cache<br />
<b>Header:</b> Poco/UniqueAccessExpireStrategy.h</p>
<h2>Description</h2>
<div class="description">
<p>An <a href="Poco.UniqueExpireStrategy.html" title="class Poco::UniqueExpireStrategy">UniqueExpireStrategy</a> implements time based expiration of cache entries. In contrast to <a href="Poco.ExpireStrategy.html" title="class Poco::ExpireStrategy">ExpireStrategy</a> which only allows to set a per cache expiration value, it allows to define  expiration per CacheEntry. Each TValue object must thus offer the following method: </p>
<p></p>
<pre>const Poco::Timestamp&amp; getTimeout() const;
</pre>
<p>which returns the timespan for how long an object will be valid without being accessed. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b>AbstractStrategy&nbsp;&lt;&nbsp;TKey,&nbsp;TValue&nbsp;&gt;</p>
<p><b>All Base Classes: </b>AbstractStrategy&nbsp;&lt;&nbsp;TKey,&nbsp;TValue&nbsp;&gt;</p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.UniqueAccessExpireStrategy.html#11984" title="Poco::UniqueAccessExpireStrategy::onAdd()">onAdd</a>, <a href="Poco.UniqueAccessExpireStrategy.html#11994" title="Poco::UniqueAccessExpireStrategy::onClear()">onClear</a>, <a href="Poco.UniqueAccessExpireStrategy.html#11991" title="Poco::UniqueAccessExpireStrategy::onGet()">onGet</a>, <a href="Poco.UniqueAccessExpireStrategy.html#11997" title="Poco::UniqueAccessExpireStrategy::onIsValid()">onIsValid</a>, <a href="Poco.UniqueAccessExpireStrategy.html#11988" title="Poco::UniqueAccessExpireStrategy::onRemove()">onRemove</a>, <a href="Poco.UniqueAccessExpireStrategy.html#12000" title="Poco::UniqueAccessExpireStrategy::onReplace()">onReplace</a></p>
<h2>Types</h2>
<h3><a name="11979">ConstIndexIterator</a></h3>
<p class="decl">typedef typename TimeIndex::const_iterator <a href="Poco.UniqueAccessExpireStrategy.html#11979" title="Poco::UniqueAccessExpireStrategy::ConstIndexIterator">ConstIndexIterator</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11978">IndexIterator</a></h3>
<p class="decl">typedef typename TimeIndex::iterator <a href="Poco.UniqueAccessExpireStrategy.html#11978" title="Poco::UniqueAccessExpireStrategy::IndexIterator">IndexIterator</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11981">Iterator</a></h3>
<p class="decl">typedef typename Keys::iterator <a href="Poco.UniqueAccessExpireStrategy.html#11981" title="Poco::UniqueAccessExpireStrategy::Iterator">Iterator</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11976">KeyExpire</a></h3>
<p class="decl">typedef std::pair &lt; TKey, <a href="Poco.Timespan.html" title="class Poco::Timespan">Timespan</a> &gt; <a href="Poco.UniqueAccessExpireStrategy.html#11976" title="Poco::UniqueAccessExpireStrategy::KeyExpire">KeyExpire</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11980">Keys</a></h3>
<p class="decl">typedef std::map &lt; TKey, <a href="Poco.UniqueAccessExpireStrategy.html#11978" title="Poco::UniqueAccessExpireStrategy::IndexIterator">IndexIterator</a> &gt; <a href="Poco.UniqueAccessExpireStrategy.html#11980" title="Poco::UniqueAccessExpireStrategy::Keys">Keys</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="11977">TimeIndex</a></h3>
<p class="decl">typedef std::multimap &lt; <a href="Poco.Timestamp.html" title="class Poco::Timestamp">Timestamp</a>, <a href="Poco.UniqueAccessExpireStrategy.html#11976" title="Poco::UniqueAccessExpireStrategy::KeyExpire">KeyExpire</a> &gt; <a href="Poco.UniqueAccessExpireStrategy.html#11977" title="Poco::UniqueAccessExpireStrategy::TimeIndex">TimeIndex</a>;</p>
<div class="description">
<p></p>
</div>
<h2>Constructors</h2>
<h3><a name="11982">UniqueAccessExpireStrategy</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.UniqueAccessExpireStrategy.html" title="class Poco::UniqueAccessExpireStrategy">UniqueAccessExpireStrategy</a>();</p>
<div class="description">
<p>Create an unique expire strategy. </p>
</div>
<h2>Destructor</h2>
<h3><a name="11983">~UniqueAccessExpireStrategy</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">~<a href="Poco.UniqueAccessExpireStrategy.html" title="class Poco::UniqueAccessExpireStrategy">UniqueAccessExpireStrategy</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="11984">onAdd</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void onAdd(<br />&nbsp;&nbsp;&nbsp;&nbsp;const void * param211,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.KeyValueArgs.html" title="class Poco::KeyValueArgs">KeyValueArgs</a> &lt; TKey,<br />&nbsp;&nbsp;&nbsp;&nbsp;TValue &gt; &amp; args<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="11994">onClear</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void onClear(<br />&nbsp;&nbsp;&nbsp;&nbsp;const void * param214,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.EventArgs.html" title="class Poco::EventArgs">EventArgs</a> &amp; args<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="11991">onGet</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void onGet(<br />&nbsp;&nbsp;&nbsp;&nbsp;const void * param213,<br />&nbsp;&nbsp;&nbsp;&nbsp;const TKey &amp; key<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="11997">onIsValid</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void onIsValid(<br />&nbsp;&nbsp;&nbsp;&nbsp;const void * param215,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.ValidArgs.html" title="class Poco::ValidArgs">ValidArgs</a> &lt; TKey &gt; &amp; args<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="11988">onRemove</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void onRemove(<br />&nbsp;&nbsp;&nbsp;&nbsp;const void * param212,<br />&nbsp;&nbsp;&nbsp;&nbsp;const TKey &amp; key<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="12000">onReplace</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void onReplace(<br />&nbsp;&nbsp;&nbsp;&nbsp;const void * param216,<br />&nbsp;&nbsp;&nbsp;&nbsp;std::set &lt; TKey &gt; &amp; elemsToRemove<br />);</p>
<div class="description">
<p></p>
</div>
<h2>Variables</h2>
<h3><a name="12004">_keyIndex</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.UniqueAccessExpireStrategy.html#11977" title="Poco::UniqueAccessExpireStrategy::TimeIndex">TimeIndex</a> _keyIndex;</p>
<div class="description">
<p>Maps time to key value </p>
</div>
<h3><a name="12003">_keys</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.UniqueAccessExpireStrategy.html#11980" title="Poco::UniqueAccessExpireStrategy::Keys">Keys</a> _keys;</p>
<div class="description">
<p>For faster replacement of keys, the iterator points to the _keyIndex map </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>