1 | // |
---|
2 | // ExpirationDecorator.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/Foundation/include/Poco/ExpirationDecorator.h#2 $ |
---|
5 | // |
---|
6 | // Library: Foundation |
---|
7 | // Package: Events |
---|
8 | // Module: ExpirationDecorator |
---|
9 | // |
---|
10 | // Implementation of the ExpirationDecorator template. |
---|
11 | // |
---|
12 | // Copyright (c) 2006, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef Foundation_ExpirationDecorator_INCLUDED |
---|
40 | #define Foundation_ExpirationDecorator_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/Timestamp.h" |
---|
44 | #include "Poco/Timespan.h" |
---|
45 | |
---|
46 | |
---|
47 | namespace Poco { |
---|
48 | |
---|
49 | |
---|
50 | template <typename TArgs> |
---|
51 | class ExpirationDecorator |
---|
52 | /// ExpirationDecorator adds an expiration method to values so that they can be used |
---|
53 | /// with the UniqueExpireCache |
---|
54 | { |
---|
55 | public: |
---|
56 | ExpirationDecorator(): |
---|
57 | _value(), |
---|
58 | _expiresAt() |
---|
59 | { |
---|
60 | } |
---|
61 | |
---|
62 | ExpirationDecorator(const TArgs& p, const Poco::Timespan::TimeDiff& diffInMs): |
---|
63 | /// Creates an element that will expire in diff milliseconds |
---|
64 | _value(p), |
---|
65 | _expiresAt() |
---|
66 | { |
---|
67 | _expiresAt += (diffInMs*1000); |
---|
68 | } |
---|
69 | |
---|
70 | ExpirationDecorator(const TArgs& p, const Poco::Timespan& timeSpan): |
---|
71 | /// Creates an element that will expire after the given timeSpan |
---|
72 | _value(p), |
---|
73 | _expiresAt() |
---|
74 | { |
---|
75 | _expiresAt += timeSpan.totalMicroseconds(); |
---|
76 | } |
---|
77 | |
---|
78 | ExpirationDecorator(const TArgs& p, const Poco::Timestamp& timeStamp): |
---|
79 | /// Creates an element that will expire at the given time point |
---|
80 | _value(p), |
---|
81 | _expiresAt(timeStamp) |
---|
82 | { |
---|
83 | } |
---|
84 | |
---|
85 | |
---|
86 | ~ExpirationDecorator() |
---|
87 | { |
---|
88 | } |
---|
89 | |
---|
90 | const Poco::Timestamp& getExpiration() const |
---|
91 | { |
---|
92 | return _expiresAt; |
---|
93 | } |
---|
94 | |
---|
95 | const TArgs& value() const |
---|
96 | { |
---|
97 | return _value; |
---|
98 | } |
---|
99 | |
---|
100 | TArgs& value() |
---|
101 | { |
---|
102 | return _value; |
---|
103 | } |
---|
104 | |
---|
105 | private: |
---|
106 | TArgs _value; |
---|
107 | Timestamp _expiresAt; |
---|
108 | }; |
---|
109 | |
---|
110 | |
---|
111 | } // namespace Poco |
---|
112 | |
---|
113 | |
---|
114 | #endif |
---|