hxtask.hpp

Go to the documentation of this file.

#pragma once
// SPDX-FileCopyrightText: © 2017-2026 Adrian Johnston.
// SPDX-License-Identifier: MIT
// This file is licensed under the MIT license found in the LICENSE.md file.

 
#include "libhatchet.h"
 
// HX_USE_MACROS_WITH_MODULE allows including macros alongside the module.
#if HX_USE_MACROS_WITH_MODULE
#error Header does not provide macros alone.
#endif
 
HX_NS_BEGIN_
 
class hxtask_queue;

class hxtask {
public:
    virtual bool execute(hxtask_queue*) = 0;

    virtual void on_completion(hxtask_queue*) { }

    virtual void on_failure(hxtask_queue*) { }

    virtual void on_cancel(hxtask_queue*) { }

    virtual const char* get_label(void) const { return "task"; }
 
private:
    friend class hxtask_queue;
 
    // Reduce confusion by separating these out.
    void process(hxtask_queue* q_) {
        if(execute(q_)) {
            on_completion(q_);
        }
        else {
            on_failure(q_);
        }
    }
};
 
HX_NS_END_