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
|
/**
* \file
* \brief DynamicThreadParameters class header
*
* \author Copyright (C) 2015-2016 Kamil Szczygiel http://www.distortec.com http://www.freddiechopin.info
*
* \par License
* This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not
* distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#ifndef INCLUDE_DISTORTOS_DYNAMICTHREADPARAMETERS_HPP_
#define INCLUDE_DISTORTOS_DYNAMICTHREADPARAMETERS_HPP_
#include "distortos/SchedulingPolicy.hpp"
#include <cstddef>
namespace distortos
{
/**
* \brief DynamicThreadParameters struct is a helper with parameters for DynamicThread's constructor
*
* This struct is a replacement for overloads of DynamicThread's constructor, makeDynamicThread() and
* makeAndStartDynamicThread() which - unfortunately - cannot be used, as they would lead to compilation errors due to
* ambiguity.
*
* \ingroup threads
*/
struct DynamicThreadParameters
{
/**
* \brief DynamicThreadParameters's constructor
*
* \param [in] stackSizee is the size of stack, bytes
* \param [in] canReceiveSignalss selects whether reception of signals is enabled (true) or disabled (false) for
* this thread
* \param [in] queuedSignalss is the max number of queued signals for this thread, relevant only if
* \a canReceiveSignals == true, 0 to disable queuing of signals for this thread
* \param [in] signalActionss is the max number of different SignalAction objects for this thread, relevant only if
* \a canReceiveSignals == true, 0 to disable catching of signals for this thread
* \param [in] priorityy is the thread's priority, 0 - lowest, UINT8_MAX - highest
* \param [in] schedulingPolicyy is the scheduling policy of the thread, default - SchedulingPolicy::roundRobin
*/
constexpr DynamicThreadParameters(const size_t stackSizee, const bool canReceiveSignalss,
const size_t queuedSignalss, const size_t signalActionss, const uint8_t priorityy,
const SchedulingPolicy schedulingPolicyy = SchedulingPolicy::roundRobin) :
queuedSignals{queuedSignalss},
signalActions{signalActionss},
stackSize{stackSizee},
canReceiveSignals{canReceiveSignalss},
priority{priorityy},
schedulingPolicy{schedulingPolicyy}
{
}
/**
* \brief DynamicThreadParameters's constructor
*
* \param [in] stackSizee is the size of stack, bytes
* \param [in] priorityy is the thread's priority, 0 - lowest, UINT8_MAX - highest
* \param [in] schedulingPolicyy is the scheduling policy of the thread, default - SchedulingPolicy::roundRobin
*/
constexpr DynamicThreadParameters(const size_t stackSizee, const uint8_t priorityy,
const SchedulingPolicy schedulingPolicyy = SchedulingPolicy::roundRobin) :
DynamicThreadParameters{stackSizee, false, 0, 0, priorityy, schedulingPolicyy}
{
}
/// max number of queued signals for this thread, relevant only if \a canReceiveSignals == true, 0 to disable
/// queuing of signals for this thread
size_t queuedSignals;
/// max number of different SignalAction objects for this thread, relevant only if \a canReceiveSignals == true, 0
/// to disable catching of signals for this thread
size_t signalActions;
/// size of stack, bytes
size_t stackSize;
/// selects whether reception of signals is enabled (true) or disabled (false) for this thread
bool canReceiveSignals;
/// thread's priority, 0 - lowest, UINT8_MAX - highest
uint8_t priority;
/// scheduling policy of the thread
SchedulingPolicy schedulingPolicy;
};
} // namespace distortos
#endif // INCLUDE_DISTORTOS_DYNAMICTHREADPARAMETERS_HPP_
|
