1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef SD_ASYNCHRONOUS_TASK_HXX
25 #define SD_ASYNCHRONOUS_TASK_HXX
26 
27 namespace sd { namespace tools {
28 
29 /** Interface for the asynchronous execution of a task.  This interface
30     allows an controller to run the task either timer based with a fixed
31     amount of time between the steps or thread based one step right after
32     the other.
33 */
34 class AsynchronousTask
35 {
36 public:
37     /** Run the next step of the task.  After HasNextStep() returns false
38         this method should ignore further calls.
39     */
40     virtual void RunNextStep (void) = 0;
41 
42     /** Return <TRUE/> when there is at least one more step to execute.
43         When the task has been executed completely then <FALSE/> is
44         returned.
45     */
46     virtual bool HasNextStep (void) = 0;
47 };
48 
49 } } // end of namespace ::sd::tools
50 
51 #endif
52