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 #ifndef SD_TIMER_BASED_TASK_EXECUTION_HXX
25*b1cdbd2cSJim Jagielski #define SD_TIMER_BASED_TASK_EXECUTION_HXX
26*b1cdbd2cSJim Jagielski 
27*b1cdbd2cSJim Jagielski #include <vcl/timer.hxx>
28*b1cdbd2cSJim Jagielski 
29*b1cdbd2cSJim Jagielski #include <boost/shared_ptr.hpp>
30*b1cdbd2cSJim Jagielski 
31*b1cdbd2cSJim Jagielski namespace sd { namespace tools {
32*b1cdbd2cSJim Jagielski 
33*b1cdbd2cSJim Jagielski class AsynchronousTask;
34*b1cdbd2cSJim Jagielski 
35*b1cdbd2cSJim Jagielski /** Execute an AsynchronousTask timer based, i.e. every
36*b1cdbd2cSJim Jagielski     nMillisecondsBetweenSteps milliseconds as much steps are executed as fit
37*b1cdbd2cSJim Jagielski     into a nMaxTimePerStep millisecond intervall.
38*b1cdbd2cSJim Jagielski 
39*b1cdbd2cSJim Jagielski     When a task is executed completely, i.e. HasNextStep() returns <FALSE/>,
40*b1cdbd2cSJim Jagielski     the TimerBasedTaskExecution destroys itself.  This, of course, works
41*b1cdbd2cSJim Jagielski     only if the creating instance does not hold a shared_ptr to  that object.
42*b1cdbd2cSJim Jagielski */
43*b1cdbd2cSJim Jagielski class TimerBasedTaskExecution
44*b1cdbd2cSJim Jagielski {
45*b1cdbd2cSJim Jagielski public:
46*b1cdbd2cSJim Jagielski     /** Create a new object of this class.
47*b1cdbd2cSJim Jagielski         @param rpTask
48*b1cdbd2cSJim Jagielski             The AsynchronousTask that is to be executed.
49*b1cdbd2cSJim Jagielski         @param nMillisecondsBetweenSteps
50*b1cdbd2cSJim Jagielski             Wait at least this long between the execution of steps.  Note
51*b1cdbd2cSJim Jagielski             that more than one step may be executed in succession.
52*b1cdbd2cSJim Jagielski         @param nMaxTimePerStep
53*b1cdbd2cSJim Jagielski             The maximal time for executing steps without yielding control.
54*b1cdbd2cSJim Jagielski     */
55*b1cdbd2cSJim Jagielski     static ::boost::shared_ptr<TimerBasedTaskExecution> Create (
56*b1cdbd2cSJim Jagielski         const ::boost::shared_ptr<AsynchronousTask>& rpTask,
57*b1cdbd2cSJim Jagielski         sal_uInt32 nMillisecondsBetweenSteps,
58*b1cdbd2cSJim Jagielski         sal_uInt32 nMaxTimePerStep);
59*b1cdbd2cSJim Jagielski 
60*b1cdbd2cSJim Jagielski     /** Stop the execution of the task and release the shared pointer to
61*b1cdbd2cSJim Jagielski         itself so that it will eventually be destroyed.
62*b1cdbd2cSJim Jagielski     */
63*b1cdbd2cSJim Jagielski     void Release (void);
64*b1cdbd2cSJim Jagielski 
65*b1cdbd2cSJim Jagielski     /** Convenience method that calls Release() on the given task.  It
66*b1cdbd2cSJim Jagielski         checks the given weak_ptr for being expired and catches bad_weak_ptr
67*b1cdbd2cSJim Jagielski         exceptions.
68*b1cdbd2cSJim Jagielski     */
69*b1cdbd2cSJim Jagielski     static void ReleaseTask (const ::boost::weak_ptr<TimerBasedTaskExecution>& rpTask);
70*b1cdbd2cSJim Jagielski 
71*b1cdbd2cSJim Jagielski private:
72*b1cdbd2cSJim Jagielski     ::boost::shared_ptr<AsynchronousTask> mpTask;
73*b1cdbd2cSJim Jagielski     Timer maTimer;
74*b1cdbd2cSJim Jagielski     /** This shared_ptr to this is used to destroy a TimerBasedTaskExecution
75*b1cdbd2cSJim Jagielski         object when its task has been executed completely.
76*b1cdbd2cSJim Jagielski     */
77*b1cdbd2cSJim Jagielski     ::boost::shared_ptr<TimerBasedTaskExecution> mpSelf;
78*b1cdbd2cSJim Jagielski     sal_uInt32 mnMaxTimePerStep;
79*b1cdbd2cSJim Jagielski 
80*b1cdbd2cSJim Jagielski     TimerBasedTaskExecution (
81*b1cdbd2cSJim Jagielski         const ::boost::shared_ptr<AsynchronousTask>& rpTask,
82*b1cdbd2cSJim Jagielski         sal_uInt32 nMillisecondsBetweenSteps,
83*b1cdbd2cSJim Jagielski         sal_uInt32 nMaxTimePerStep);
84*b1cdbd2cSJim Jagielski     ~TimerBasedTaskExecution (void);
85*b1cdbd2cSJim Jagielski     void SetSelf (const ::boost::shared_ptr<TimerBasedTaskExecution>& rpSelf);
86*b1cdbd2cSJim Jagielski 
87*b1cdbd2cSJim Jagielski     class Deleter;
88*b1cdbd2cSJim Jagielski     friend class Deleter;
89*b1cdbd2cSJim Jagielski 
90*b1cdbd2cSJim Jagielski     DECL_LINK(TimerCallback,Timer*);
91*b1cdbd2cSJim Jagielski };
92*b1cdbd2cSJim Jagielski 
93*b1cdbd2cSJim Jagielski } } // end of namespace ::sd::tools
94*b1cdbd2cSJim Jagielski 
95*b1cdbd2cSJim Jagielski #endif
96