forked from ChunelFeng/CGraph
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathUThreadPool.h
More file actions
202 lines (174 loc) · 5.94 KB
/
UThreadPool.h
File metadata and controls
202 lines (174 loc) · 5.94 KB
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
/***************************
@Author: Chunel
@Contact: chunel@foxmail.com
@File: UThreadPool.h
@Time: 2021/7/4 1:34 下午
@Desc:
***************************/
#ifndef CGRAPH_UTHREADPOOL_H
#define CGRAPH_UTHREADPOOL_H
#include <vector>
#include <list>
#include <map>
#include <future>
#include <thread>
#include <algorithm>
#include <memory>
#include <functional>
#include "UThreadObject.h"
#include "UThreadPoolConfig.h"
#include "Queue/UQueueInclude.h"
#include "Thread/UThreadInclude.h"
#include "Task/UTaskInclude.h"
CGRAPH_NAMESPACE_BEGIN
class UThreadPool : public UThreadObject {
public:
/**
* 通过默认设置参数，来创建线程池
* @param autoInit 是否自动开启线程池功能
* @param config
*/
explicit UThreadPool(CBool autoInit = true,
const UThreadPoolConfig& config = UThreadPoolConfig()) noexcept;
/**
* 析构函数
*/
~UThreadPool() override;
/**
* 设置线程池相关配置信息，需要在init()函数调用前，完成设置
* @param config
* @return
* @notice 通过单例类(UThreadPoolSingleton)开启线程池，则线程池默认init。需要 destroy 后才可以设置参数
*/
CStatus setConfig(const UThreadPoolConfig &config);
/**
* 获取线程池配置信息
* @return
*/
UThreadPoolConfig getConfig() const;
/**
* 开启所有的线程信息
* @return
*/
CStatus init() final;
/**
* 提交任务信息
* @tparam FunctionType
* @param task
* @param index
* @return
*/
template<typename FunctionType>
auto commit(const FunctionType& task,
CIndex index = CGRAPH_DEFAULT_TASK_STRATEGY)
-> std::future<decltype(std::declval<FunctionType>()())>;
/**
* 向特定的线程id中，提交任务信息
* @tparam FunctionType
* @param task
* @param tid 线程id。如果超出主线程个数范围，则默认写入pool的通用队列中
* @param enable 是否启用上锁/解锁功能
* @param lockable 上锁(true) / 解锁(false)
* @return
*/
template<typename FunctionType>
auto commitWithTid(const FunctionType& task, CIndex tid, CBool enable, CBool lockable)
-> std::future<decltype(std::declval<FunctionType>()())>;
/**
* 根据优先级，执行任务
* @tparam FunctionType
* @param task
* @param priority 优先级别。自然序从大到小依次执行
* @return
* @notice 建议，priority 范围在 [-100, 100] 之间
*/
template<typename FunctionType>
auto commitWithPriority(const FunctionType& task,
int priority)
-> std::future<decltype(std::declval<FunctionType>()())>;
/**
* 异步执行任务
* @tparam FunctionType
* @param task
* @param index
*/
template<typename FunctionType>
CVoid execute(const FunctionType& task,
CIndex index = CGRAPH_DEFAULT_TASK_STRATEGY);
/**
* 执行任务组信息
* 取taskGroup内部ttl和入参ttl的最小值，为计算ttl标准
* @param taskGroup
* @param ttl
* @return
*/
CStatus submit(const UTaskGroup& taskGroup,
CMSec ttl = CGRAPH_MAX_BLOCK_TTL);
/**
* 针对单个任务的情况，复用任务组信息，实现单个任务直接执行
* @param task
* @param ttl
* @param onFinished
* @return
*/
CStatus submit(CGRAPH_DEFAULT_CONST_FUNCTION_REF func,
CMSec ttl = CGRAPH_MAX_BLOCK_TTL,
CGRAPH_CALLBACK_CONST_FUNCTION_REF onFinished = nullptr);
/**
* 获取根据线程id信息，获取线程index信息
* @param tid
* @return
* @notice 辅助线程返回-1
*/
CIndex getThreadIndex(CSize tid);
/**
* 释放所有的线程信息
* @return
*/
CStatus destroy() final;
/**
* 判断线程池是否已经初始化了
* @return
*/
CBool isInit() const;
/**
* 生成辅助线程。内部确保辅助线程数量不超过设定参数
* @param size
* @return
*/
CStatus createSecondaryThread(CInt size);
/**
* 删除辅助线程
* @param size
* @return
*/
CStatus releaseSecondaryThread(CInt size);
protected:
/**
* 根据传入的策略信息，确定最终执行方式
* @param origIndex
* @return
*/
virtual CIndex dispatch(CIndex origIndex);
/**
* 监控线程执行函数，主要是判断是否需要增加线程，或销毁线程
* 增/删 操作，仅针对secondary类型线程生效
*/
CVoid monitor();
CGRAPH_NO_ALLOWED_COPY(UThreadPool)
private:
CBool is_init_ { false }; // 是否初始化
CInt cur_index_ = 0; // 记录放入的线程数
UAtomicQueue<UTask> task_queue_; // 用于存放普通任务
UAtomicPriorityQueue<UTask> priority_task_queue_; // 运行时间较长的任务队列，仅在辅助线程中执行
std::vector<UThreadPrimaryPtr> primary_threads_; // 记录所有的主线程
std::list<std::unique_ptr<UThreadSecondary>> secondary_threads_; // 用于记录所有的辅助线程
UThreadPoolConfig config_; // 线程池设置值
std::thread monitor_thread_; // 监控线程
std::map<CSize, int> thread_record_map_; // 线程记录的信息
std::mutex st_mutex_; // 辅助线程发生变动的时候，加的mutex信息
};
using UThreadPoolPtr = UThreadPool *;
CGRAPH_NAMESPACE_END
#include "UThreadPool.inl"
#endif //CGRAPH_UTHREADPOOL_H