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_ASYNCHRONOUS_TASK_HXX 25*b1cdbd2cSJim Jagielski #define SD_ASYNCHRONOUS_TASK_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski namespace sd { namespace tools { 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski /** Interface for the asynchronous execution of a task. This interface 30*b1cdbd2cSJim Jagielski allows an controller to run the task either timer based with a fixed 31*b1cdbd2cSJim Jagielski amount of time between the steps or thread based one step right after 32*b1cdbd2cSJim Jagielski the other. 33*b1cdbd2cSJim Jagielski */ 34*b1cdbd2cSJim Jagielski class AsynchronousTask 35*b1cdbd2cSJim Jagielski { 36*b1cdbd2cSJim Jagielski public: 37*b1cdbd2cSJim Jagielski /** Run the next step of the task. After HasNextStep() returns false 38*b1cdbd2cSJim Jagielski this method should ignore further calls. 39*b1cdbd2cSJim Jagielski */ 40*b1cdbd2cSJim Jagielski virtual void RunNextStep (void) = 0; 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski /** Return <TRUE/> when there is at least one more step to execute. 43*b1cdbd2cSJim Jagielski When the task has been executed completely then <FALSE/> is 44*b1cdbd2cSJim Jagielski returned. 45*b1cdbd2cSJim Jagielski */ 46*b1cdbd2cSJim Jagielski virtual bool HasNextStep (void) = 0; 47*b1cdbd2cSJim Jagielski }; 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski } } // end of namespace ::sd::tools 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski #endif 52