/* * Copyright (C) 2025 Linux Studio Plugins Project * (C) 2025 Vladimir Sadovnikov * * This file is part of lsp-runtime-lib * Created on: 27 янв. 2016 г. * * lsp-runtime-lib is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 3 of the License, or * any later version. * * lsp-runtime-lib is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with lsp-runtime-lib. If not, see . */ #ifndef LSP_PLUG_IN_IPC_ITASK_H_ #define LSP_PLUG_IN_IPC_ITASK_H_ #include #include #include #include namespace lsp { namespace ipc { class IExecutor; /** * Task interface. Task can be submitted to executor object for asynchronous execution. */ class ITask: public IRunnable { public: enum task_state_t { TS_IDLE, TS_SUBMITTED, TS_RUNNING, TS_COMPLETED }; protected: ITask *pNext; // Pointer to next task queue ipc::IExecutor *pExecutor; // Nested executor if present int nCode; // Execution code int nState; // Task state protected: // Executor service friend class IExecutor; static inline bool successful(int code) { return code == STATUS_OK; }; public: ITask(); ITask(const ITask &) = delete; ITask(ITask &&) = delete; virtual ~ITask() override; ITask & operator = (const ITask &) = delete; ITask & operator = (ITask &&) = delete; public: virtual status_t run() override; public: /** Get current state of task * * @return current task state */ inline task_state_t state() const { return task_state_t(atomic_load(&nState)); } /** Check that task status is idle * * @return true if task status is idle */ inline bool idle() const { return state() == TS_IDLE; } /** Check that task status is submitted * * @return true if task status is submitted */ inline bool submitted() const { return state() == TS_SUBMITTED; } /** Check that task status is running * * @return true if task status is running */ inline bool running() const { return state() == TS_RUNNING; } /** Check that task status is completed * * @return true if task status is completed */ inline bool completed() const { return state() == TS_COMPLETED; } /** Check that execution was successful * * @return true if execution was successful; */ inline bool successful() const { return successful(nCode); } /** Get last execution code * * @return last execution code */ inline int code() const { return nCode; } /** * Reset task state. The state can be reset only if task is in completed state. * * @return true if task has been reset */ inline bool reset() { return atomic_cas(&nState, TS_COMPLETED, TS_IDLE); } }; } /* namespace ipc */ } /* namespace lsp */ #endif /* LSP_PLUG_IN_IPC_ITASK_H_ */