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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
/*************************************************************************
*
* $RCSfile: disposetimer.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: lla $ $Date: 2001-01-17 15:02:34 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef CONFIGMGR_DISPOSETIMER_HXX
#define CONFIGMGR_DISPOSETIMER_HXX
#include "apitypes.hxx"
#include "timestamp.hxx"
#include "options.hxx"
#include <osl/mutex.hxx>
#include <vos/timer.hxx>
#include <map>
#include <queue>
namespace configmgr
{
class TreeManager;
////////////////////////////////////////////////////////////////////////////////
/* OTreeDisposeScheduler:
does something special????
*/
class OTreeDisposeScheduler
{
typedef std::multimap< TimeStamp, vos::ORef< OOptions >, ltTimeStamp > Agenda;
class Timer : public vos::OTimer
{
public:
OTreeDisposeScheduler& rParent;
Timer(OTreeDisposeScheduler& _rParent) : rParent(_rParent) {};
// vos::OTimer
virtual void SAL_CALL onShot();
};
friend void Timer::onShot();
private:
mutable osl::Mutex m_aMutex;
Agenda m_aAgenda;
vos::ORef<Timer> m_xTimer;
TreeManager& m_rTreeManager;
TimeInterval m_aCleanupDelay;
TimeInterval m_aCleanupInterval;
public:
//-------- Construction and destruction -----------------------------------
explicit
OTreeDisposeScheduler(TreeManager& _rTreeManager, TimeInterval const& _aCleanupDelay)
: m_xTimer(0)
, m_rTreeManager(_rTreeManager)
, m_aCleanupDelay(_aCleanupDelay)
, m_aCleanupInterval(_aCleanupDelay)
{}
explicit
OTreeDisposeScheduler(TreeManager& _rTreeManager, TimeInterval const& _aCleanupDelay, TimeInterval const& _aCleanupInterval)
: m_xTimer(0)
, m_rTreeManager(_rTreeManager)
, m_aCleanupDelay(_aCleanupDelay)
, m_aCleanupInterval(_aCleanupInterval)
{}
~OTreeDisposeScheduler() { stopAndClearTasks(); }
//-------- Delay and Interval ---------------------------------------------
/// sets the initial delay to be used for cleanup in the future, does not affect an already started process
void setCleanupDelay(TimeInterval const& _aCleanupDelay)
{
osl::MutexGuard aGuard(m_aMutex);
m_aCleanupDelay = _aCleanupDelay;
}
/// sets the initial delay and recurrance interval to be used for cleanup in the future, does not affect an already started process
void setCleanupDelay(TimeInterval const& _aCleanupDelay, TimeInterval const& _aCleanupInterval)
{
osl::MutexGuard aGuard(m_aMutex);
m_aCleanupDelay = _aCleanupDelay;
m_aCleanupInterval = _aCleanupInterval;
}
/// sets the recurrance interval to be used for cleanup in the future, does not affect an already started process
void setCleanupInterval(TimeInterval const& _aCleanupInterval)
{
osl::MutexGuard aGuard(m_aMutex);
m_aCleanupInterval = _aCleanupInterval;
}
/// retrieves the initial delay used for cleanup
TimeInterval const& getCleanupDelay() const
{
osl::MutexGuard aGuard(m_aMutex);
return m_aCleanupDelay;
}
/// retrieves the recurrance interval used for cleanup
TimeInterval const& getCleanupInterval() const
{
osl::MutexGuard aGuard(m_aMutex);
return m_aCleanupInterval;
}
/// calculate the time when to cleanup an pbject that became eligible at <var>aBaseTime</var>.
TimeStamp getCleanupTime(TimeStamp const& aBaseTime = TimeStamp::getCurrentTime())
{
return implGetCleanupTime(aBaseTime, getCleanupDelay());
}
//-------- Control of execution ------------------------------------------
/// ensure this will execute cleanup duties for _xOptions (no later than after getCleanupDelay() has elapsed)
void scheduleCleanup(vos::ORef< OOptions > const& _xOptions);
/// stop and discard pending activities for _xOptions
void clearTasks(vos::ORef< OOptions > const& _xOptions);
/// stop and discard pending activities
void stopAndClearTasks();
private:
// vos::OTimer
void onTimerShot();
vos::ORef< OOptions > getTask(TimeStamp const& _aActualTime, TimeStamp& _aNextTime);
TimeStamp runDisposer(TimeStamp const& _aActualTime);
private:
TimeStamp implAddTask(vos::ORef< OOptions > const& _xOptions, TimeStamp const& _aTime);
void implStartBefore(TimeStamp const& _aTime);
static TimeStamp implGetCleanupTime(TimeStamp const& aBaseTime, TimeInterval const& aDelay)
{ return aBaseTime + aDelay; }
};
// -----------------------------------------------------------------------------
// Write down the Cache, much less complex than caching Nodes
// (better control)
class OTreeCacheWriteScheduler
{
typedef std::vector<vos::ORef< OOptions > > CacheWriteList; // fire and forget!
class Timer : public vos::OTimer
{
public:
OTreeCacheWriteScheduler& rParent;
Timer(OTreeCacheWriteScheduler& _rParent) : rParent(_rParent) {};
// vos::OTimer
virtual void SAL_CALL onShot();
};
friend void Timer::onShot();
private:
mutable osl::Mutex m_aMutex;
vos::ORef<Timer> m_xTimer;
TreeManager& m_rTreeManager;
CacheWriteList m_aWriteList;
// TimeInterval m_aCleanupDelay;
TimeInterval m_aCleanupInterval;
bool m_bSyncron; // if true, write syncron only, no timer thread
public:
//-------- Construction and destruction -----------------------------------
explicit
OTreeCacheWriteScheduler(TreeManager& _rTreeManager, TimeInterval const& _aCleanupDelay, bool _bSyncron)
: m_xTimer(0)
, m_rTreeManager(_rTreeManager)
, m_aCleanupInterval(_aCleanupDelay)
, m_bSyncron(_bSyncron)
{}
~OTreeCacheWriteScheduler();
//-------- Delay and Interval ---------------------------------------------
/// retrieves the recurrance interval used for cleanup
TimeInterval const& getCleanupInterval() const
{
osl::MutexGuard aGuard(m_aMutex);
return m_aCleanupInterval;
}
/// calculate the time when to cleanup an pbject that became eligible at <var>aBaseTime</var>.
TimeStamp getCleanupTime(TimeStamp const& aBaseTime = TimeStamp::getCurrentTime())
{
return implGetCleanupTime(aBaseTime, getCleanupInterval());
}
static TimeStamp implGetCleanupTime(TimeStamp const& aBaseTime, TimeInterval const& aDelay)
{
return aBaseTime + aDelay;
}
//-------- Control of execution ------------------------------------------
/// stop and discard pending activities for _xOptions
// void writeCache(vos::ORef< OOptions > const& _xOptions);
void scheduleWrite(vos::ORef< OOptions > const& _xOptions, bool _bSync = false);
/// stop and discard pending activities
void stopAndWriteCache();
private:
// vos::OTimer
void onTimerShot();
void runDisposer();
void implStartBefore(TimeStamp const& _aTime);
};
////////////////////////////////////////////////////////////////////////////////
} // namespace configmgr
#endif // CONFIGMGR_DISPOSETIMER_HXX
|
