1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski // MARKER(update_precomp.py): autogen include statement, do not remove
25*b1cdbd2cSJim Jagielski #include "precompiled_sd.hxx"
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski #include "tools/TimerBasedTaskExecution.hxx"
28*b1cdbd2cSJim Jagielski #include "tools/AsynchronousTask.hxx"
29*b1cdbd2cSJim Jagielski #include <tools/time.hxx>
30*b1cdbd2cSJim Jagielski #include <osl/diagnose.h>
31*b1cdbd2cSJim Jagielski #include <boost/weak_ptr.hpp>
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski #undef VERBOSE
34*b1cdbd2cSJim Jagielski
35*b1cdbd2cSJim Jagielski namespace sd { namespace tools {
36*b1cdbd2cSJim Jagielski
37*b1cdbd2cSJim Jagielski /** Used by the shared_ptr instead of the private destructor.
38*b1cdbd2cSJim Jagielski */
39*b1cdbd2cSJim Jagielski class TimerBasedTaskExecution::Deleter
40*b1cdbd2cSJim Jagielski {
41*b1cdbd2cSJim Jagielski public:
operator ()(TimerBasedTaskExecution * pObject)42*b1cdbd2cSJim Jagielski void operator() (TimerBasedTaskExecution* pObject)
43*b1cdbd2cSJim Jagielski {
44*b1cdbd2cSJim Jagielski delete pObject;
45*b1cdbd2cSJim Jagielski }
46*b1cdbd2cSJim Jagielski };
47*b1cdbd2cSJim Jagielski
48*b1cdbd2cSJim Jagielski
49*b1cdbd2cSJim Jagielski
50*b1cdbd2cSJim Jagielski
Create(const::boost::shared_ptr<AsynchronousTask> & rpTask,sal_uInt32 nMillisecondsBetweenSteps,sal_uInt32 nMaxTimePerStep)51*b1cdbd2cSJim Jagielski ::boost::shared_ptr<TimerBasedTaskExecution> TimerBasedTaskExecution::Create (
52*b1cdbd2cSJim Jagielski const ::boost::shared_ptr<AsynchronousTask>& rpTask,
53*b1cdbd2cSJim Jagielski sal_uInt32 nMillisecondsBetweenSteps,
54*b1cdbd2cSJim Jagielski sal_uInt32 nMaxTimePerStep)
55*b1cdbd2cSJim Jagielski {
56*b1cdbd2cSJim Jagielski ::boost::shared_ptr<TimerBasedTaskExecution> pExecution(
57*b1cdbd2cSJim Jagielski new TimerBasedTaskExecution(rpTask,nMillisecondsBetweenSteps,nMaxTimePerStep),
58*b1cdbd2cSJim Jagielski Deleter());
59*b1cdbd2cSJim Jagielski // Let the new object have a shared_ptr to itself, so that it can
60*b1cdbd2cSJim Jagielski // release itself when the AsynchronousTask has been executed
61*b1cdbd2cSJim Jagielski // completely.
62*b1cdbd2cSJim Jagielski pExecution->SetSelf(pExecution);
63*b1cdbd2cSJim Jagielski return pExecution;
64*b1cdbd2cSJim Jagielski }
65*b1cdbd2cSJim Jagielski
66*b1cdbd2cSJim Jagielski
67*b1cdbd2cSJim Jagielski
68*b1cdbd2cSJim Jagielski
Release(void)69*b1cdbd2cSJim Jagielski void TimerBasedTaskExecution::Release (void)
70*b1cdbd2cSJim Jagielski {
71*b1cdbd2cSJim Jagielski maTimer.Stop();
72*b1cdbd2cSJim Jagielski mpSelf.reset();
73*b1cdbd2cSJim Jagielski }
74*b1cdbd2cSJim Jagielski
75*b1cdbd2cSJim Jagielski
76*b1cdbd2cSJim Jagielski
77*b1cdbd2cSJim Jagielski
78*b1cdbd2cSJim Jagielski //static
ReleaseTask(const::boost::weak_ptr<TimerBasedTaskExecution> & rpExecution)79*b1cdbd2cSJim Jagielski void TimerBasedTaskExecution::ReleaseTask (
80*b1cdbd2cSJim Jagielski const ::boost::weak_ptr<TimerBasedTaskExecution>& rpExecution)
81*b1cdbd2cSJim Jagielski {
82*b1cdbd2cSJim Jagielski if ( ! rpExecution.expired())
83*b1cdbd2cSJim Jagielski {
84*b1cdbd2cSJim Jagielski try
85*b1cdbd2cSJim Jagielski {
86*b1cdbd2cSJim Jagielski ::boost::shared_ptr<tools::TimerBasedTaskExecution> pExecution (rpExecution);
87*b1cdbd2cSJim Jagielski pExecution->Release();
88*b1cdbd2cSJim Jagielski }
89*b1cdbd2cSJim Jagielski catch (::boost::bad_weak_ptr)
90*b1cdbd2cSJim Jagielski {
91*b1cdbd2cSJim Jagielski // When a bad_weak_ptr has been thrown then the object pointed
92*b1cdbd2cSJim Jagielski // to by rpTask has been released right after we checked that it
93*b1cdbd2cSJim Jagielski // still existed. Too bad, but that means, that we have nothing
94*b1cdbd2cSJim Jagielski // more do.
95*b1cdbd2cSJim Jagielski }
96*b1cdbd2cSJim Jagielski }
97*b1cdbd2cSJim Jagielski }
98*b1cdbd2cSJim Jagielski
99*b1cdbd2cSJim Jagielski
100*b1cdbd2cSJim Jagielski
101*b1cdbd2cSJim Jagielski
TimerBasedTaskExecution(const::boost::shared_ptr<AsynchronousTask> & rpTask,sal_uInt32 nMillisecondsBetweenSteps,sal_uInt32 nMaxTimePerStep)102*b1cdbd2cSJim Jagielski TimerBasedTaskExecution::TimerBasedTaskExecution (
103*b1cdbd2cSJim Jagielski const ::boost::shared_ptr<AsynchronousTask>& rpTask,
104*b1cdbd2cSJim Jagielski sal_uInt32 nMillisecondsBetweenSteps,
105*b1cdbd2cSJim Jagielski sal_uInt32 nMaxTimePerStep)
106*b1cdbd2cSJim Jagielski : mpTask(rpTask),
107*b1cdbd2cSJim Jagielski maTimer(),
108*b1cdbd2cSJim Jagielski mpSelf(),
109*b1cdbd2cSJim Jagielski mnMaxTimePerStep(nMaxTimePerStep)
110*b1cdbd2cSJim Jagielski {
111*b1cdbd2cSJim Jagielski Link aLink(LINK(this,TimerBasedTaskExecution,TimerCallback));
112*b1cdbd2cSJim Jagielski maTimer.SetTimeoutHdl(aLink);
113*b1cdbd2cSJim Jagielski maTimer.SetTimeout(nMillisecondsBetweenSteps);
114*b1cdbd2cSJim Jagielski maTimer.Start();
115*b1cdbd2cSJim Jagielski }
116*b1cdbd2cSJim Jagielski
117*b1cdbd2cSJim Jagielski
118*b1cdbd2cSJim Jagielski
119*b1cdbd2cSJim Jagielski
~TimerBasedTaskExecution(void)120*b1cdbd2cSJim Jagielski TimerBasedTaskExecution::~TimerBasedTaskExecution (void)
121*b1cdbd2cSJim Jagielski {
122*b1cdbd2cSJim Jagielski maTimer.Stop();
123*b1cdbd2cSJim Jagielski }
124*b1cdbd2cSJim Jagielski
125*b1cdbd2cSJim Jagielski
126*b1cdbd2cSJim Jagielski
127*b1cdbd2cSJim Jagielski
SetSelf(const::boost::shared_ptr<TimerBasedTaskExecution> & rpSelf)128*b1cdbd2cSJim Jagielski void TimerBasedTaskExecution::SetSelf (
129*b1cdbd2cSJim Jagielski const ::boost::shared_ptr<TimerBasedTaskExecution>& rpSelf)
130*b1cdbd2cSJim Jagielski {
131*b1cdbd2cSJim Jagielski if (mpTask.get() != NULL)
132*b1cdbd2cSJim Jagielski mpSelf = rpSelf;
133*b1cdbd2cSJim Jagielski }
134*b1cdbd2cSJim Jagielski
135*b1cdbd2cSJim Jagielski
136*b1cdbd2cSJim Jagielski
137*b1cdbd2cSJim Jagielski
IMPL_LINK(TimerBasedTaskExecution,TimerCallback,Timer *,EMPTYARG)138*b1cdbd2cSJim Jagielski IMPL_LINK(TimerBasedTaskExecution,TimerCallback, Timer*,EMPTYARG)
139*b1cdbd2cSJim Jagielski {
140*b1cdbd2cSJim Jagielski if (mpTask.get() != NULL)
141*b1cdbd2cSJim Jagielski {
142*b1cdbd2cSJim Jagielski if (mpTask->HasNextStep())
143*b1cdbd2cSJim Jagielski {
144*b1cdbd2cSJim Jagielski // Execute as many steps as fit into the time span of length
145*b1cdbd2cSJim Jagielski // mnMaxTimePerStep. Note that the last step may take longer
146*b1cdbd2cSJim Jagielski // than allowed.
147*b1cdbd2cSJim Jagielski sal_uInt32 nStartTime (Time().GetMSFromTime());
148*b1cdbd2cSJim Jagielski #ifdef VERBOSE
149*b1cdbd2cSJim Jagielski OSL_TRACE("starting TimerBasedTaskExecution at %d", nStartTime);
150*b1cdbd2cSJim Jagielski #endif
151*b1cdbd2cSJim Jagielski do
152*b1cdbd2cSJim Jagielski {
153*b1cdbd2cSJim Jagielski mpTask->RunNextStep();
154*b1cdbd2cSJim Jagielski sal_uInt32 nDuration (Time().GetMSFromTime()-nStartTime);
155*b1cdbd2cSJim Jagielski #ifdef VERBOSE
156*b1cdbd2cSJim Jagielski OSL_TRACE("executed step in %d", nDuration);
157*b1cdbd2cSJim Jagielski #endif
158*b1cdbd2cSJim Jagielski if (nDuration > mnMaxTimePerStep)
159*b1cdbd2cSJim Jagielski break;
160*b1cdbd2cSJim Jagielski }
161*b1cdbd2cSJim Jagielski while (mpTask->HasNextStep());
162*b1cdbd2cSJim Jagielski #ifdef VERBOSE
163*b1cdbd2cSJim Jagielski OSL_TRACE("TimerBasedTaskExecution sleeping");
164*b1cdbd2cSJim Jagielski #endif
165*b1cdbd2cSJim Jagielski maTimer.Start();
166*b1cdbd2cSJim Jagielski }
167*b1cdbd2cSJim Jagielski else
168*b1cdbd2cSJim Jagielski mpSelf.reset();
169*b1cdbd2cSJim Jagielski }
170*b1cdbd2cSJim Jagielski
171*b1cdbd2cSJim Jagielski return 0;
172*b1cdbd2cSJim Jagielski }
173*b1cdbd2cSJim Jagielski
174*b1cdbd2cSJim Jagielski
175*b1cdbd2cSJim Jagielski } } // end of namespace ::sd::tools
176*b1cdbd2cSJim Jagielski
177