Line data    Source code

       1             : //
       2             : // Copyright 2024 OpenModelViewer Authors
       3             : // 
       4             : // Licensed under the Apache License, Version 2.0 (the "License");
       5             : // you may not use this file except in compliance with the License.
       6             : // You may obtain a copy of the License at
       7             : // 
       8             : //     http://www.apache.org/licenses/LICENSE-2.0
       9             : // 
      10             : // Unless required by applicable law or agreed to in writing, software
      11             : // distributed under the License is distributed on an "AS IS" BASIS,
      12             : // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      13             : // See the License for the specific language governing permissions and
      14             : // limitations under the License.
      15             : //
      16             : 
      17             : #pragma once
      18             : 
      19             : namespace openmodelviewer::core::async
      20             : {
      21             :     /**
      22             :      * @brief Interface for a generic asynchronous task.
      23             :      *
      24             :      * This abstract base class defines the interface for all tasks
      25             :      * that can be executed by the thread pool. Each task must implement
      26             :      * the execute() method, which performs the actual work.
      27             :      */
      28             :     struct ITask
      29             :     {
      30          88 :         virtual ~ITask() = default;
      31             : 
      32             :         /**
      33             :          * @brief Executes the task logic.
      34             :          *
      35             :          * This method must be implemented by all concrete task classes.
      36             :          * It defines the actual work to be performed when the task is executed
      37             :          * by a worker thread in the thread pool.
      38             :          */
      39             :         virtual void execute() = 0;
      40             :     };
      41             : } // namespace openmodelviewer::core::async