← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/poco/gutsy

« back to all changes in this revision

Viewing changes to Foundation/include/Poco/ExpirationDecorator.h

  • Committer: Bazaar Package Importer
  • Author(s): Krzysztof Burghardt
  • Date: 2007-04-27 18:33:48 UTC
  • Revision ID: james.westby@ubuntu.com-20070427183348-xgnpct0qd6a2ip34
Tags: upstream-1.2.9
Import upstream version 1.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
Foundation/include/Poco/ExpirationDecorator.h
 
1
//
 
2
// ExpirationDecorator.h
 
3
//
 
4
// $Id: //poco/1.2/Foundation/include/Poco/ExpirationDecorator.h#1 $
 
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
        ExpirationDecorator(const TArgs& p, const Poco::Timespan& timeSpan):
 
70
                /// Creates an element that will expire after the given timeSpan
 
71
                _value(p),
 
72
                _expiresAt()
 
73
        {
 
74
                _expiresAt += timeSpan.totalMicroseconds();
 
75
        }
 
76
 
 
77
        ExpirationDecorator(const TArgs& p, const Poco::Timestamp& timeStamp):
 
78
                /// Creates an element that will expire at the given time point
 
79
                _value(p),
 
80
                _expiresAt(timeStamp)
 
81
        {
 
82
        }
 
83
 
 
84
 
 
85
        ~ExpirationDecorator()
 
86
        {
 
87
        }
 
88
        
 
89
        const Poco::Timestamp& getExpiration() const
 
90
        {
 
91
                return _expiresAt;
 
92
        }
 
93
 
 
94
        const TArgs& value() const
 
95
        {
 
96
                return _value;
 
97
        }
 
98
 
 
99
        TArgs& value()
 
100
        {
 
101
                return _value;
 
102
        }
 
103
 
 
104
private:
 
105
        TArgs     _value;
 
106
        Timestamp _expiresAt;
 
107
};
 
108
 
 
109
 
 
110
} // namespace Poco
 
111
 
 
112
 
 
113
#endif