aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/thread/Task.h
blob: d4e4df0539586d6108c8abbdec22e397c82da2c4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/**
 * Copyright (C) 2021 Saturneric <[email protected]>
 *
 * This file is part of GpgFrontend.
 *
 * GpgFrontend is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * GpgFrontend 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
 *
 * The initial version of the source code is inherited from
 * the gpg4usb project, which is under GPL-3.0-or-later.
 *
 * All the source code of GpgFrontend was modified and released by
 * Saturneric <[email protected]> starting on May 12, 2021.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */

#pragma once

#include "core/GpgFrontendCore.h"
#include "core/thread/DataObject.h"

namespace GpgFrontend::Thread {

class TaskRunner;
extern const std::string DEFAULT_TASK_NAME;

class DataObject;
using DataObjectPtr = std::shared_ptr<DataObject>;  ///<

class GPGFRONTEND_CORE_EXPORT Task : public QObject, public QRunnable {
  Q_OBJECT
 public:
  friend class TaskRunner;

  using TaskRunnable = std::function<int(DataObjectPtr)>;        ///<
  using TaskCallback = std::function<void(int, DataObjectPtr)>;  ///<

  /**
   * @brief Construct a new Task object
   *
   */
  Task(std::string name = DEFAULT_TASK_NAME);

  /**
   * @brief Construct a new Task object
   *
   * @param callback The callback function to be executed.
   */
  explicit Task(TaskRunnable runnable, std::string name = DEFAULT_TASK_NAME,
                DataObjectPtr data_object = nullptr, bool sequency = true);

  /**
   * @brief Construct a new Task object
   *
   * @param runnable
   */
  explicit Task(
      TaskRunnable runnable, std::string name, DataObjectPtr data,
      TaskCallback callback = [](int, const std::shared_ptr<DataObject> &) {},
      bool sequency = true);

  /**
   * @brief Destroy the Task object
   *
   */
  virtual ~Task() override;

  /**
   * @brief Run - run the task
   *
   */
  virtual void Run();

  /**
   * @brief
   *
   * @return std::string
   */
  std::string GetUUID() const;

  /**
   * @brief
   *
   * @return std::string
   */
  std::string GetFullID() const;

  /**
   * @brief
   *
   * @return std::string
   */
  bool GetSequency() const;

 public slots:

  /**
   * @brief
   *
   */
  void SlotRun();

 signals:
  /**
   * @brief announce runnable finished
   *
   */
  void SignalTaskRunnableEnd(int rtn);

  /**
   * @brief runnable and callabck all finished
   *
   */
  void SignalTaskEnd();

 protected:
  /**
   * @brief Set the Finish After Run object
   *
   * @param finish_after_run
   */
  void HoldOnLifeCycle(bool hold_on);

  /**
   * @brief
   *
   * @param rtn
   */
  void SetRTN(int rtn);

 private:
  class Impl;
  std::unique_ptr<Impl> p_;

  virtual void run() override;
};
}  // namespace GpgFrontend::Thread