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